Skip to content

Commit

Permalink
[Docs] Clarify accessing Date methods in painless (#33560)
Browse files Browse the repository at this point in the history
The documentation currently tells users to use `doc['event_date'].value.getMillis` to access
milliseconds in a date. It turns out the way it works is `doc['event_date'].value.millis`. This 
change corrects this and gives a hint at how other date related methods work.
  • Loading branch information
Christoph Büscher authored Sep 19, 2018
1 parent a3e8b83 commit 6f3b333
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions docs/painless/painless-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -198,13 +198,11 @@ POST hockey/player/1/_update
==== Dates

Date fields are exposed as
`ReadableDateTime` or
so they support methods like
`getYear`,
and `getDayOfWeek`.
To get milliseconds since epoch call
`getMillis`.
For example, the following returns every hockey player's birth year:
`ReadableDateTime`, so they support methods like `getYear`, `getDayOfWeek`
or e.g. getting milliseconds since epoch with `getMillis`. To use these
in a script, leave out the `get` prefix and continue with lowercasing the
rest of the method name. For example, the following returns every hockey
player's birth year:

[source,js]
----------------------------------------------------------------
Expand Down

0 comments on commit 6f3b333

Please sign in to comment.