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

36 lines
878 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
[[rollup-api-quickref]]
== API Quick Reference
[Docs] All Rollup docs experimental, agg limitations, clarify DeleteJob (#31299) - All rollup pages should be marked as experimental instead of just the top page - While the job config docs state which aggregations are allowed, adding a section which specifically details this in one place is more convenient for the user - Add a clarification that the DeleteJob API does not delete the rollup data, just the rollup job.
2018-06-13 15:42:20 -04:00
experimental[]
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
Most {rollup} endpoints have the following base:
[source,js]
----
/_xpack/rollup/
----
// NOTCONSOLE
[float]
[[rollup-api-jobs]]
=== /job/
* {ref}/rollup-put-job.html[PUT /job/<job_id+++>+++]: Create a job
* {ref}/rollup-get-job.html[GET /job]: List jobs
* {ref}/rollup-get-job.html[GET /job/<job_id+++>+++]: Get job details
* {ref}/rollup-start-job.html[POST /job/<job_id>/_start]: Start a job
* {ref}/rollup-stop-job.html[POST /job/<job_id+++>+++]: Stop a job
* {ref}/rollup-delete-job.html[DELETE /job/<job_id+++>+++]: Delete a job
[float]
[[rollup-api-data]]
=== /data/
* {ref}/rollup-get-rollup-caps.html[GET /data/<index_name+++>/_rollup_caps+++]: Get Rollup Capabilities
[float]
[[rollup-api-index]]
=== /<index_name>/
* {ref}/rollup-search.html[GET /<index_name>/_rollup_search]: Search rollup data