honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-03-30 03:48:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Add anchors for scripted metric aggregations (#53618)

Browse Source
This commit is contained in:
Lisa Cawley 2020-03-16 12:14:01 -07:00 committed by lcawl
parent 508e5239b4
commit 278e3fce50
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/reference/aggregations/metrics/scripted-metric-aggregation.asciidoc
View File

@ -102,6 +102,7 @@ Verify this response as well but in a hidden block.
For more details on specifying scripts see <<modules-scripting, script documentation>>. For more details on specifying scripts see <<modules-scripting, script documentation>>.
[[scripted-metric-aggregation-return-types]]
==== Allowed return types ==== Allowed return types
Whilst any valid script object can be used within a single script, the scripts must return or store in the `state` object only the following types: Whilst any valid script object can be used within a single script, the scripts must return or store in the `state` object only the following types:
@ -111,6 +112,7 @@ Whilst any valid script object can be used within a single script, the scripts m
* Map (containing only keys and values of the types listed here) * Map (containing only keys and values of the types listed here)
* Array (containing elements of only the types listed here) * Array (containing elements of only the types listed here)
[[scripted-metric-aggregation-scope]]
==== Scope of scripts ==== Scope of scripts
The scripted metric aggregation uses scripts at 4 stages of its execution: The scripted metric aggregation uses scripts at 4 stages of its execution:
@ -139,7 +141,8 @@ reduce_script:: Executed once on the coordinating node after all shards have
In the above example, the `reduce_script` iterates through the `profit` returned by each shard summing the values before returning the In the above example, the `reduce_script` iterates through the `profit` returned by each shard summing the values before returning the
final combined profit which will be returned in the response of the aggregation. final combined profit which will be returned in the response of the aggregation.
==== Worked Example [[scripted-metric-aggregation-example]]
==== Worked example
Imagine a situation where you index the following documents into an index with 2 shards: Imagine a situation where you index the following documents into an index with 2 shards:
@ -255,7 +258,8 @@ produce the response:
-------------------------------------------------- --------------------------------------------------
// NOTCONSOLE // NOTCONSOLE
==== Other Parameters [[scripted-metric-aggregation-parameters]]
==== Other parameters
[horizontal] [horizontal]
params:: Optional. An object whose contents will be passed as variables to the `init_script`, `map_script` and `combine_script`. This can be params:: Optional. An object whose contents will be passed as variables to the `init_script`, `map_script` and `combine_script`. This can be
@ -268,7 +272,8 @@ params:: Optional. An object whose contents will be passed as variable
-------------------------------------------------- --------------------------------------------------
// NOTCONSOLE // NOTCONSOLE
==== Empty Buckets [[scripted-metric-aggregation-empty-buckets]]
==== Empty buckets
If a parent bucket of the scripted metric aggregation does not collect any documents an empty aggregation response will be returned from the If a parent bucket of the scripted metric aggregation does not collect any documents an empty aggregation response will be returned from the
shard with a `null` value. In this case the `reduce_script`'s `states` variable will contain `null` as a response from that shard. shard with a `null` value. In this case the `reduce_script`'s `states` variable will contain `null` as a response from that shard.