honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: Fixed variations of spelling of buckets_path 

Closes #13201
This commit is contained in:
Clinton Gormley 2015-08-31 13:47:40 +02:00
parent a80317c4b3
commit aa52c4f712
11 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/reference/aggregations/pipeline.asciidoc
View File

@ -18,9 +18,9 @@ _Sibling_::
Pipeline aggregations that are provided with the output of a sibling aggregation and are able to compute a
new aggregation which will be at the same level as the sibling aggregation.
Pipeline aggregations can reference the aggregations they need to perform their computation by using the `buckets_paths`
Pipeline aggregations can reference the aggregations they need to perform their computation by using the `buckets_path`
parameter to indicate the paths to the required metrics. The syntax for defining these paths can be found in the
<<bucket-path-syntax, `buckets_path` Syntax>> section below.
<<buckets-path-syntax, `buckets_path` Syntax>> section below.
Pipeline aggregations cannot have sub-aggregations but depending on the type it can reference another pipeline in the `buckets_path`
allowing pipeline aggregations to be chained. For example, you can chain together two derivatives to calculate the second derivative
@ -29,7 +29,7 @@ allowing pipeline aggregations to be chained. For example, you can chain togeth
NOTE: Because pipeline aggregations only add to the output, when chaining pipeline aggregations the output of each pipeline aggregation
will be included in the final output.
[[bucket-path-syntax]]
[[buckets-path-syntax]]
[float]
=== `buckets_path` Syntax
@ -96,13 +96,13 @@ a metric embedded inside a sibling aggregation:
},
"max_monthly_sales": {
"max_bucket": {
"buckets_paths": "sales_per_month>sales" <1>
"buckets_path": "sales_per_month>sales" <1>
}
}
}
}
--------------------------------------------------
<1> `bucket_paths` instructs this max_bucket aggregation that we want the maximum value of the `sales` aggregation in the
<1> `buckets_path` instructs this max_bucket aggregation that we want the maximum value of the `sales` aggregation in the
`sales_per_month` date histogram.
[float]

2
docs/reference/aggregations/pipeline/avg-bucket-aggregation.asciidoc
View File

@ -24,7 +24,7 @@ An `avg_bucket` aggregation looks like this in isolation:
.`avg_bucket` Parameters
|===
|Parameter Name |Description |Required |Default Value
|`buckets_path` |The path to the buckets we wish to find the average for (see <<bucket-path-syntax>> for more
|`buckets_path` |The path to the buckets we wish to find the average for (see <<buckets-path-syntax>> for more
details) |Required |
|`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
details)|Optional, defaults to `skip` ||

4
docs/reference/aggregations/pipeline/bucket-script-aggregation.asciidoc
View File

@ -34,7 +34,7 @@ the metrics to use for that variable.
|`script` |The script to run for this aggregation. The script can be inline, file or indexed. (see <<modules-scripting>>
for more details) |Required |
|`buckets_path` |A map of script variables and their associated path to the buckets we wish to use for the variable
(see <<bucket-path-syntax>> for more details) |Required |
(see <<buckets-path-syntax>> for more details) |Required |
|`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
details)|Optional, defaults to `skip` |
|`format` |format to apply to the output value of this aggregation |Optional, defaults to `null` |
@ -73,7 +73,7 @@ The following snippet calculates the ratio percentage of t-shirt sales compared
},
"t-shirt-percentage": {
"bucket_script": {
"buckets_paths": {
"buckets_path": {
"tShirtSales": "t-shirts>sales",
"totalSales": "total_sales"
},

4
docs/reference/aggregations/pipeline/bucket-selector-aggregation.asciidoc
View File

@ -39,7 +39,7 @@ the metrics to use for that variable.
|`script` |The script to run for this aggregation. The script can be inline, file or indexed. (see <<modules-scripting>>
for more details) |Required |
|`buckets_path` |A map of script variables and their associated path to the buckets we wish to use for the variable
(see <<bucket-path-syntax>> for more details) |Required |
(see <<buckets-path-syntax>> for more details) |Required |
|`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
details)|Optional, defaults to `skip` |
|===
@ -63,7 +63,7 @@ The following snippet only retains buckets where the total sales for the month i
}
"sales_bucket_filter": {
"bucket_selector": {
"buckets_paths": {
"buckets_path": {
"totalSales": "total_sales"
},
"script": "totalSales <= 50"

6
docs/reference/aggregations/pipeline/cumulative-sum-aggregation.asciidoc
View File

@ -25,7 +25,7 @@ A `cumulative_sum` aggregation looks like this in isolation:
.`cumulative_sum` Parameters
|===
|Parameter Name |Description |Required |Default Value
|`buckets_path` |The path to the buckets we wish to find the cumulative sum for (see <<bucket-path-syntax>> for more
|`buckets_path` |The path to the buckets we wish to find the cumulative sum for (see <<buckets-path-syntax>> for more
details) |Required |
|`format` |format to apply to the output value of this aggregation |Optional, defaults to `null` |
|===
@ -49,7 +49,7 @@ The following snippet calculates the cumulative sum of the total monthly `sales`
},
"cumulative_sales": {
"cumulative_sum": {
"buckets_paths": "sales" <1>
"buckets_path": "sales" <1>
}
}
}
@ -58,7 +58,7 @@ The following snippet calculates the cumulative sum of the total monthly `sales`
}
--------------------------------------------------
<1> `bucket_paths` instructs this cumulative sum aggregation to use the output of the `sales` aggregation for the cumulative sum
<1> `buckets_path` instructs this cumulative sum aggregation to use the output of the `sales` aggregation for the cumulative sum
And the following may be the response:

2
docs/reference/aggregations/pipeline/derivative-aggregation.asciidoc
View File

@ -25,7 +25,7 @@ A `derivative` aggregation looks like this in isolation:
.`derivative` Parameters
|===
|Parameter Name |Description |Required |Default Value
|`buckets_path` |The path to the buckets we wish to find the derivative for (see <<bucket-path-syntax>> for more
|`buckets_path` |The path to the buckets we wish to find the derivative for (see <<buckets-path-syntax>> for more
details) |Required |
|`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
details)|Optional, defaults to `skip` |

6
docs/reference/aggregations/pipeline/max-bucket-aggregation.asciidoc
View File

@ -25,7 +25,7 @@ A `max_bucket` aggregation looks like this in isolation:
.`max_bucket` Parameters
|===
|Parameter Name |Description |Required |Default Value
|`buckets_path` |The path to the buckets we wish to find the maximum for (see <<bucket-path-syntax>> for more
|`buckets_path` |The path to the buckets we wish to find the maximum for (see <<buckets-path-syntax>> for more
details) |Required |
|`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
details)|Optional, defaults to `skip` |
@ -53,13 +53,13 @@ The following snippet calculates the maximum of the total monthly `sales`:
},
"max_monthly_sales": {
"max_bucket": {
"buckets_paths": "sales_per_month>sales" <1>
"buckets_path": "sales_per_month>sales" <1>
}
}
}
}
--------------------------------------------------
<1> `bucket_paths` instructs this max_bucket aggregation that we want the maximum value of the `sales` aggregation in the
<1> `buckets_path` instructs this max_bucket aggregation that we want the maximum value of the `sales` aggregation in the
`sales_per_month` date histogram.
And the following may be the response:

6
docs/reference/aggregations/pipeline/min-bucket-aggregation.asciidoc
View File

@ -25,7 +25,7 @@ A `max_bucket` aggregation looks like this in isolation:
.`min_bucket` Parameters
|===
|Parameter Name |Description |Required |Default Value
|`buckets_path` |The path to the buckets we wish to find the minimum for (see <<bucket-path-syntax>> for more
|`buckets_path` |The path to the buckets we wish to find the minimum for (see <<buckets-path-syntax>> for more
details) |Required |
|`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
details)|Optional, defaults to `skip` |
@ -54,14 +54,14 @@ The following snippet calculates the minimum of the total monthly `sales`:
},
"min_monthly_sales": {
"min_bucket": {
"buckets_paths": "sales_per_month>sales" <1>
"buckets_path": "sales_per_month>sales" <1>
}
}
}
}
--------------------------------------------------
<1> `bucket_paths` instructs this max_bucket aggregation that we want the minimum value of the `sales` aggregation in the
<1> `buckets_path` instructs this max_bucket aggregation that we want the minimum value of the `sales` aggregation in the
`sales_per_month` date histogram.
And the following may be the response:

4
docs/reference/aggregations/pipeline/movavg-aggregation.asciidoc
View File

@ -40,7 +40,7 @@ A `moving_avg` aggregation looks like this in isolation:
.`moving_avg` Parameters
|===
|Parameter Name |Description |Required |Default Value
|`buckets_path` |Path to the metric of interest (see <<bucket-path-syntax, `buckets_path` Syntax>> for more details |Required |
|`buckets_path` |Path to the metric of interest (see <<buckets-path-syntax, `buckets_path` Syntax>> for more details |Required |
|`model` |The moving average weighting model that we wish to use |Optional |`simple`
|`gap_policy` |Determines what should happen when a gap in the data is encountered. |Optional |`insert_zero`
|`window` |The size of window to "slide" across the histogram. |Optional |`5`
@ -78,7 +78,7 @@ embedded like any other metric aggregation:
Moving averages are built by first specifying a `histogram` or `date_histogram` over a field. You can then optionally
add normal metrics, such as a `sum`, inside of that histogram. Finally, the `moving_avg` is embedded inside the histogram.
The `buckets_path` parameter is then used to "point" at one of the sibling metrics inside of the histogram (see
<<bucket-path-syntax>> for a description of the syntax for `buckets_path`.
<<buckets-path-syntax>> for a description of the syntax for `buckets_path`.
==== Models

4
docs/reference/aggregations/pipeline/serial-diff-aggregation.asciidoc
View File

@ -52,7 +52,7 @@ A `serial_diff` aggregation looks like this in isolation:
.`moving_avg` Parameters
|===
|Parameter Name |Description |Required |Default Value
|`buckets_path` |Path to the metric of interest (see <<bucket-path-syntax, `buckets_path` Syntax>> for more details |Required |
|`buckets_path` |Path to the metric of interest (see <<buckets-path-syntax, `buckets_path` Syntax>> for more details |Required |
|`lag` |The historical bucket to subtract from the current value. E.g. a lag of 7 will subtract the current value from
the value 7 buckets ago. Must be a positive, non-zero integer |Optional |`1`
|`gap_policy` |Determines what should happen when a gap in the data is encountered. |Optional |`insert_zero`
@ -94,7 +94,7 @@ A `serial_diff` aggregation looks like this in isolation:
Serial differences are built by first specifying a `histogram` or `date_histogram` over a field. You can then optionally
add normal metrics, such as a `sum`, inside of that histogram. Finally, the `serial_diff` is embedded inside the histogram.
The `buckets_path` parameter is then used to "point" at one of the sibling metrics inside of the histogram (see
<<bucket-path-syntax>> for a description of the syntax for `buckets_path`.
<<buckets-path-syntax>> for a description of the syntax for `buckets_path`.

6
docs/reference/aggregations/pipeline/sum-bucket-aggregation.asciidoc
View File

@ -24,7 +24,7 @@ A `sum_bucket` aggregation looks like this in isolation:
.`sum_bucket` Parameters
|===
|Parameter Name |Description |Required |Default Value
|`buckets_path` |The path to the buckets we wish to find the sum for (see <<bucket-path-syntax>> for more
|`buckets_path` |The path to the buckets we wish to find the sum for (see <<buckets-path-syntax>> for more
details) |Required |
|`gap_policy` |The policy to apply when gaps are found in the data (see <<gap-policy>> for more
details)|Optional, defaults to `skip` ||
@ -52,13 +52,13 @@ The following snippet calculates the sum of all the total monthly `sales` bucket
},
"sum_monthly_sales": {
"sum_bucket": {
"buckets_paths": "sales_per_month>sales" <1>
"buckets_path": "sales_per_month>sales" <1>
}
}
}
}
--------------------------------------------------
<1> `bucket_paths` instructs this sum_bucket aggregation that we want the sum of the `sales` aggregation in the
<1> `buckets_path` instructs this sum_bucket aggregation that we want the sum of the `sales` aggregation in the
`sales_per_month` date histogram.
And the following may be the response: