[ASTERIXDB-2450][DOC] make docs match implementation
details:
- change site documentation to match function implementation
- add example for ms_from_day_time_duration
Change-Id: Iacd4cd18b232df7845c80bdb6136f28185193905
Reviewed-on: https://asterix-gerrit.ics.uci.edu/3153
Sonar-Qube: Jenkins <jenkins@fulliautomatix.ics.uci.edu>
Integration-Tests: Jenkins <jenkins@fulliautomatix.ics.uci.edu>
Reviewed-by: Preston Carman <prestonc@apache.org>
Reviewed-by: Dmitry Lychagin <dmitry.lychagin@couchbase.com>
Tested-by: Dmitry Lychagin <dmitry.lychagin@couchbase.com>
diff --git a/asterixdb/asterix-doc/src/main/markdown/builtins/7_temporal.md b/asterixdb/asterix-doc/src/main/markdown/builtins/7_temporal.md
index cee47ba..dd07124 100644
--- a/asterixdb/asterix-doc/src/main/markdown/builtins/7_temporal.md
+++ b/asterixdb/asterix-doc/src/main/markdown/builtins/7_temporal.md
@@ -157,28 +157,30 @@
year_month_duration("P1Y")
-### months_from_year_month_duration/milliseconds_from_day_time_duration ###
+### months_from_year_month_duration/ms_from_day_time_duration ###
* Syntax:
- months_from_year_month_duration/milliseconds_from_day_time_duration(duration_value)
+ months_from_year_month_duration/ms_from_day_time_duration(duration_value)
* Extracts the number of months or the number of milliseconds from the `duration` subtype.
* Arguments:
* `duration_value` : a `duration` of the correct subtype.
* Return Value:
- * an `bigint` representing the number or months/milliseconds,
+ * a `bigint` representing the number of months/milliseconds,
* `missing` if the argument is a `missing` value,
* `null` if the argument is a `null` value,
* any other non-duration input value will cause a type error.
* Example:
- months_from_year_month_duration(get_year_month_duration(duration("P5Y7MT50M")));
-
+ {
+ "months": months_from_year_month_duration(get_year_month_duration(duration("P5Y7MT50M"))),
+ "milliseconds": ms_from_day_time_duration(get_day_time_duration(duration("P5Y7MT50M")))
+ };
* The expected result is:
- 67
+ {"months": 67, "milliseconds": 3000000}
### duration_from_months/duration_from_ms ###