mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 21:18:31 +00:00
bf1550a0b2
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@dcde91aacf
35 lines
802 B
Plaintext
35 lines
802 B
Plaintext
[role="xpack"]
|
|
[[rollup-apis]]
|
|
== Rollup APIs
|
|
|
|
[float]
|
|
[[rollup-jobs-endpoint]]
|
|
=== Jobs
|
|
|
|
* <<rollup-put-job,Create Job>>, <<rollup-delete-job,Delete Job>>,
|
|
* <<rollup-start-job,Start Job>>, <<rollup-stop-job,Stop Job>>,
|
|
* <<rollup-get-job,Get Job, List all Jobs>>
|
|
* <<rollup-job-config,Job configuration details>>
|
|
|
|
[float]
|
|
[[rollup-data-endpoint]]
|
|
=== Data
|
|
|
|
* <<rollup-get-rollup-caps,Get Rollup Capabilities>>
|
|
|
|
[float]
|
|
[[rollup-search-endpoint]]
|
|
=== Search
|
|
|
|
* <<rollup-search,Rollup Search>>
|
|
|
|
|
|
|
|
include::rollup/delete-job.asciidoc[]
|
|
include::rollup/get-job.asciidoc[]
|
|
include::rollup/put-job.asciidoc[]
|
|
include::rollup/start-job.asciidoc[]
|
|
include::rollup/stop-job.asciidoc[]
|
|
include::rollup/rollup-caps.asciidoc[]
|
|
include::rollup/rollup-search.asciidoc[]
|
|
include::rollup/rollup-job-config.asciidoc[] |