Skip to content

Commit 65f65fa

Browse files
authored
Merge branch 'main' into restore-execute-watch-examples
2 parents f53fd4f + 5f84c0f commit 65f65fa

File tree

2 files changed

+3
-25
lines changed

2 files changed

+3
-25
lines changed

specification/_doc_ids/table.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -614,6 +614,7 @@ retrieve-stored-fields,https://www.elastic.co/docs/reference/elasticsearch/rest-
614614
role-restriction,https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/role-restriction,
615615
rollup-agg-limitations,https://www.elastic.co/docs/manage-data/lifecycle/rollup/rollup-aggregation-limitations,
616616
rollup-delete-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-delete-job,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/rollup-delete-job.html
617+
rollup-examples,https://www.elastic.co/docs/manage-data/lifecycle/rollup/getting-started-api#historical-only-search-example,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/rollup-search.html#rollup-search-example
617618
rollup-get-job,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-jobs,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/rollup-get-job.html
618619
rollup-get-rollup-caps,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-caps,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/rollup-get-rollup-caps.html
619620
rollup-get-rollup-index-caps,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-index-caps,https://www.elastic.co/guide/en/elasticsearch/reference/8.18/rollup-get-rollup-index-caps.html

specification/rollup/rollup_search/RollupSearchRequest.ts

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -35,36 +35,13 @@ import { Dictionary } from '@spec_utils/Dictionary'
3535
* `size`: Because rollups work on pre-aggregated data, no search hits can be returned and so size must be set to zero or omitted entirely.
3636
* `highlighter`, `suggestors`, `post_filter`, `profile`, `explain`: These are similarly disallowed.
3737
*
38-
* **Searching both historical rollup and non-rollup data**
38+
* For more detailed examples of using the rollup search API, including querying rolled-up data only or combining rolled-up and live data, refer to the External documentation.
3939
*
40-
* The rollup search API has the capability to search across both "live" non-rollup data and the aggregated rollup data.
41-
* This is done by simply adding the live indices to the URI. For example:
42-
*
43-
* ```
44-
* GET sensor-1,sensor_rollup/_rollup_search
45-
* {
46-
* "size": 0,
47-
* "aggregations": {
48-
* "max_temperature": {
49-
* "max": {
50-
* "field": "temperature"
51-
* }
52-
* }
53-
* }
54-
* }
55-
* ```
56-
*
57-
* The rollup search endpoint does two things when the search runs:
58-
*
59-
* * The original request is sent to the non-rollup index unaltered.
60-
* * A rewritten version of the original request is sent to the rollup index.
61-
*
62-
* When the two responses are received, the endpoint rewrites the rollup response and merges the two together.
63-
* During the merging process, if there is any overlap in buckets between the two responses, the buckets from the non-rollup index are used.
6440
* @rest_spec_name rollup.rollup_search
6541
* @availability stack since=6.3.0 stability=experimental
6642
* @deprecated 8.11.0
6743
* @doc_id rollup-search
44+
* @ext_doc_id rollup-examples
6845
*/
6946
export interface Request extends RequestBase {
7047
urls: [

0 commit comments

Comments
 (0)