honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/rollup/rollup-api.asciidoc

35 lines
827 B
Plaintext
Raw Normal View History

Rollups for Elasticsearch (elastic/x-pack-elasticsearch#4002) This adds a new Rollup module to XPack, which allows users to configure periodic "rollup jobs" to pre-aggregate data. That data is then available later for search through a special RollupSearch API, which mimics the DSL and functionality of regular search. Rollups are used to drastically reduce the on-disk footprint of metric-based data (e.g. timestamped document with numeric and keyword fields). It can also be used to speed up aggregations over large datasets, since the rolled data will be considerably smaller and fewer documents to search. The PR adds seven new endpoints to interact with Rollups; create/get/delete job, start/stop job, a capabilities API similar to field-caps, and a Rollup-enabled search. Original commit: elastic/x-pack-elasticsearch@dcde91aacfa52d2985e3948cb64392061e2b10c1
2018-02-23 17:10:37 -05:00
[role="xpack"]
[DOCS] Move rollup APIs to docs (#31450)
2018-08-31 13:50:43 -04:00
[testenv="basic"]
Rollups for Elasticsearch (elastic/x-pack-elasticsearch#4002) This adds a new Rollup module to XPack, which allows users to configure periodic "rollup jobs" to pre-aggregate data. That data is then available later for search through a special RollupSearch API, which mimics the DSL and functionality of regular search. Rollups are used to drastically reduce the on-disk footprint of metric-based data (e.g. timestamped document with numeric and keyword fields). It can also be used to speed up aggregations over large datasets, since the rolled data will be considerably smaller and fewer documents to search. The PR adds seven new endpoints to interact with Rollups; create/get/delete job, start/stop job, a capabilities API similar to field-caps, and a Rollup-enabled search. Original commit: elastic/x-pack-elasticsearch@dcde91aacfa52d2985e3948cb64392061e2b10c1
2018-02-23 17:10:37 -05:00
[[rollup-apis]]
== Rollup APIs
[float]
[[rollup-jobs-endpoint]]
=== Jobs
[DOCS] Reformat rollup APIs to use new API format (#44131)
2019-07-10 18:12:32 -04:00
* <<rollup-put-job,Create>> or <<rollup-delete-job,delete {rollup-jobs}>>
* <<rollup-start-job,Start>> or <<rollup-stop-job,stop {rollup-jobs}>>
* <<rollup-get-job,Get {rollup-jobs}>>
Rollups for Elasticsearch (elastic/x-pack-elasticsearch#4002) This adds a new Rollup module to XPack, which allows users to configure periodic "rollup jobs" to pre-aggregate data. That data is then available later for search through a special RollupSearch API, which mimics the DSL and functionality of regular search. Rollups are used to drastically reduce the on-disk footprint of metric-based data (e.g. timestamped document with numeric and keyword fields). It can also be used to speed up aggregations over large datasets, since the rolled data will be considerably smaller and fewer documents to search. The PR adds seven new endpoints to interact with Rollups; create/get/delete job, start/stop job, a capabilities API similar to field-caps, and a Rollup-enabled search. Original commit: elastic/x-pack-elasticsearch@dcde91aacfa52d2985e3948cb64392061e2b10c1
2018-02-23 17:10:37 -05:00
[float]
[[rollup-data-endpoint]]
=== Data
* <<rollup-get-rollup-caps,Get Rollup Capabilities>>
[Docs] Tweaks and fixes to rollup docs - Missing links to new IndexCaps API - Incorrect security permissions on IndexCaps API - GetJobs API must supply a job (or `_all`), omitting throws error - Link to search/agg limitations from RollupSearch API - Tweak URLs in quick reference - Formatting of overview page
2018-08-17 13:33:12 -04:00
* <<rollup-get-rollup-index-caps,Get Rollup Index Capabilities>>
Rollups for Elasticsearch (elastic/x-pack-elasticsearch#4002) This adds a new Rollup module to XPack, which allows users to configure periodic "rollup jobs" to pre-aggregate data. That data is then available later for search through a special RollupSearch API, which mimics the DSL and functionality of regular search. Rollups are used to drastically reduce the on-disk footprint of metric-based data (e.g. timestamped document with numeric and keyword fields). It can also be used to speed up aggregations over large datasets, since the rolled data will be considerably smaller and fewer documents to search. The PR adds seven new endpoints to interact with Rollups; create/get/delete job, start/stop job, a capabilities API similar to field-caps, and a Rollup-enabled search. Original commit: elastic/x-pack-elasticsearch@dcde91aacfa52d2985e3948cb64392061e2b10c1
2018-02-23 17:10:37 -05:00
[float]
[[rollup-search-endpoint]]
=== Search
* <<rollup-search,Rollup Search>>
[DOCS] Reformat rollup APIs to use new API format (#44131)
2019-07-10 18:12:32 -04:00
include::apis/put-job.asciidoc[]
[DOCS] Move rollup APIs to docs (#31450)
2018-08-31 13:50:43 -04:00
include::apis/delete-job.asciidoc[]
include::apis/get-job.asciidoc[]
include::apis/rollup-caps.asciidoc[]
include::apis/rollup-index-caps.asciidoc[]
include::apis/rollup-search.asciidoc[]
[DOCS] Reformat rollup APIs to use new API format (#44131)
2019-07-10 18:12:32 -04:00
include::apis/start-job.asciidoc[]
include::apis/stop-job.asciidoc[]