Skip to content

Update script-fields-api.md #2209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 23, 2025
Merged

Update script-fields-api.md #2209

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a781623
Update script-fields-api.md
philippkahr Jul 22, 2025
0d2e426
Update explore-analyze/scripting/script-fields-api.md
philippkahr Jul 22, 2025
c0400b6
Merge branch 'main' into philippkahr-patch-1
florent-leborgne Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion explore-analyze/scripting/script-fields-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ Use the `field` API to access document fields:
field('my_field').get(<default_value>)
```

Alternatively use the shortcut of `$` to get a field.

```painless
$('my_field', <default_value>)
```

This API fundamentally changes how you access documents in Painless. Previously, you had to access the `doc` map with the field name that you wanted to access:

```painless
Expand Down Expand Up @@ -77,7 +83,6 @@ ZonedDateTime end = field('end').get(null);
return start == null || end == null ? -1 : ChronoUnit.MILLIS.between(start, end)
```


## Supported mapped field types [_supported_mapped_field_types]

The following table indicates the mapped field types that the `field` API supports. For each supported type, values are listed that are returned by the `field` API (from the `get` and `as<Type>` methods) and the `doc` map (from the `getValue` and `get` methods).
Expand Down Expand Up @@ -112,3 +117,20 @@ The `fields` API currently doesn’t support some fields, but you can still acce
| `wildcard` | `String` | - | `String` | `String` |
| `flattened` | `String` | - | `String` | `String` |

## Manipulation of the fields data

The field API provides a `set(<value>)` operation that will take the field name and create the necessary structure. Calling this inside an ingest pipelines script processor context:

```painless
field("foo.bar").set("abc")
```

leads to the generation of this JSON representation.

```json
{
"foo": {
"bar": "abc"
}
}
```
Loading