Skip to content

Commit 1e41d60

Browse files
committed
[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.
1 parent 43631e8 commit 1e41d60

15 files changed

+81
-3
lines changed

x-pack/docs/en/rest-api/rollup/delete-job.asciidoc

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,37 @@
55
<titleabbrev>Delete Job</titleabbrev>
66
++++
77

8+
experimental[]
9+
810
This API deletes an existing rollup job. The job can be started or stopped, in both cases it will be deleted. Attempting
911
to delete a non-existing job will throw an exception
1012

13+
.Deleting the job does not delete rolled up data
14+
**********************************
15+
When a job is deleted, that only removes the process that is actively monitoring and rolling up data.
16+
It does not delete any previously rolled up data. This is by design; a user may wish to roll up a static dataset. Because
17+
the dataset is static, once it has been fully rolled up there is no need to keep the indexing Rollup job around (as there
18+
will be no new data). So the job may be deleted, leaving behind the rolled up data for analysis.
19+
20+
If you wish to also remove the rollup data, and the rollup index only contains the data for a single job, you can simply
21+
delete the whole rollup index. If the rollup index stores data from several jobs, you must issue a Delete-By-Query that
22+
targets the Rollup job's ID in the rollup index:
23+
24+
25+
[source,js]
26+
--------------------------------------------------
27+
POST my_rollup_index/_delete_by_query
28+
{
29+
"query": {
30+
"term": {
31+
"_rollup.id": "the_rollup_job_id"
32+
}
33+
}
34+
}
35+
--------------------------------------------------
36+
// NOTCONSOLE
37+
38+
**********************************
1139
==== Request
1240

1341
`DELETE _xpack/rollup/job/<job_id>`

x-pack/docs/en/rest-api/rollup/get-job.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
<titleabbrev>Get Job</titleabbrev>
66
++++
77

8+
experimental[]
9+
810
This API returns the configuration, stats and status of rollup jobs. The API can return the details for a single job,
911
or for all jobs.
1012

x-pack/docs/en/rest-api/rollup/put-job.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
<titleabbrev>Create Job</titleabbrev>
66
++++
77

8+
experimental[]
9+
810
This API enables you to create a rollup job. The job will be created in a `STOPPED` state, and must be
911
started with the <<rollup-start-job,Start Job API>>.
1012

x-pack/docs/en/rest-api/rollup/rollup-caps.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
<titleabbrev>Get Rollup Caps</titleabbrev>
66
++++
77

8+
experimental[]
9+
810
This API returns the rollup capabilities that have been configured for an index or index pattern. This API is useful
911
because a rollup job is often configured to rollup only a subset of fields from the source index. Furthermore, only
1012
certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on

x-pack/docs/en/rest-api/rollup/rollup-job-config.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
[[rollup-job-config]]
33
=== Rollup Job Configuration
44

5+
experimental[]
6+
57
The Rollup Job Configuration contains all the details about how the rollup job should run, when it indexes documents,
68
and what future queries will be able to execute against the rollup index.
79

x-pack/docs/en/rest-api/rollup/rollup-search.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
<titleabbrev>Rollup Search</titleabbrev>
66
++++
77

8+
experimental[]
9+
810
The Rollup Search endpoint allows searching rolled-up data using the standard query DSL. The Rollup Search endpoint
911
is needed because, internally, rolled-up documents utilize a different document structure than the original data. The
1012
Rollup Search endpoint rewrites standard query DSL into a format that matches the rollup documents, then takes the response

x-pack/docs/en/rest-api/rollup/start-job.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
<titleabbrev>Start Job</titleabbrev>
66
++++
77

8+
experimental[]
9+
810
This API starts an existing, stopped rollup job. If the job does not exist an exception will be thrown.
911
Starting an already started job has no action.
1012

x-pack/docs/en/rest-api/rollup/stop-job.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
<titleabbrev>Stop Job</titleabbrev>
66
++++
77

8+
experimental[]
9+
810
This API stops an existing, started rollup job. If the job does not exist an exception will be thrown.
911
Stopping an already stopped job has no action.
1012

x-pack/docs/en/rollup/api-quickref.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
[[rollup-api-quickref]]
22
== API Quick Reference
33

4+
experimental[]
5+
46
Most {rollup} endpoints have the following base:
57

68
[source,js]

x-pack/docs/en/rollup/index.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ for analysis, but at a fraction of the storage cost of raw data.
1818
* <<rollup-getting-started,Getting Started>>
1919
* <<rollup-api-quickref, API Quick Reference>>
2020
* <<rollup-understanding-groups,Understanding Rollup Grouping>>
21-
* <<rollup-search-limitations,Limitations of Rollup Search>>
21+
* <<rollup-agg-limitations,Rollup aggregation limitations>>
22+
* <<rollup-search-limitations,Rollup Search limitations>>
2223

2324

2425
--
@@ -27,4 +28,5 @@ include::overview.asciidoc[]
2728
include::api-quickref.asciidoc[]
2829
include::rollup-getting-started.asciidoc[]
2930
include::understanding-groups.asciidoc[]
31+
include::rollup-agg-limitations.asciidoc[]
3032
include::rollup-search-limitations.asciidoc[]

0 commit comments

Comments
 (0)