This is an automated email from the ASF dual-hosted git repository.
gian pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/druid.git
The following commit(s) were added to refs/heads/master by this push:
new 1d6c9657ec Clarify compaction docs. (#14225)
1d6c9657ec is described below
commit 1d6c9657ec362199b80993b68a0bfbe4118ea29a
Author: Gian Merlino <[email protected]>
AuthorDate: Fri Jun 23 15:24:15 2023 -0700
Clarify compaction docs. (#14225)
* Clarify compaction docs.
The prior wording made it sound like segmentGranularity, queryGranularity,
and rollup are always required for granularitySpec. They are not required,
but they are strongly recommended. The adjusted wording hopefully does
a better job of making that clear.
* Fix link.
* Wording adjustments.
---
docs/data-management/automatic-compaction.md | 8 ++++----
docs/data-management/compaction.md | 4 ++--
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/docs/data-management/automatic-compaction.md
b/docs/data-management/automatic-compaction.md
index 866ca2407d..d7c0bb8495 100644
--- a/docs/data-management/automatic-compaction.md
+++ b/docs/data-management/automatic-compaction.md
@@ -115,11 +115,11 @@ The following properties are automatically set by the
Coordinator:
* `id`: Generated using the task type, datasource name, interval, and
timestamp. The task ID is prefixed with `coordinator-issued`.
* `context`: Set according to the user-provided `taskContext`.
-Compaction tasks fetch all [relevant
segments](compaction.md#compaction-io-configuration) prior to launching any
subtasks,
-_unless_ the following items are all set. It is strongly recommended to set
all of these items to maximize performance
-and minimize disk usage of the `compact` tasks launched by auto-compaction:
+Compaction tasks typically fetch all [relevant
segments](compaction.md#compaction-io-configuration) prior to launching any
subtasks,
+_unless_ the following properties are all set to non-null values. It is
strongly recommended to set them to non-null values to
+maximize performance and minimize disk usage of the `compact` tasks launched
by auto-compaction:
-- [`granularitySpec`](compaction.md#compaction-granularity-spec). All three
values must be set to non-null values: `segmentGranularity`,
`queryGranularity`, and `rollup`.
+- [`granularitySpec`](compaction.md#compaction-granularity-spec), with
non-null values for each of `segmentGranularity`, `queryGranularity`, and
`rollup`
- [`dimensionsSpec`](compaction.md#compaction-dimensions-spec)
- `metricsSpec`
diff --git a/docs/data-management/compaction.md
b/docs/data-management/compaction.md
index 3e833469e8..96a7c07609 100644
--- a/docs/data-management/compaction.md
+++ b/docs/data-management/compaction.md
@@ -138,9 +138,9 @@ To control the number of result segments per time chunk,
you can set [`maxRowsPe
A compaction task internally generates an `index` or `index_parallel` task
spec for performing compaction work with some fixed parameters. For example,
its `inputSource` is always the [`druid` input
source](../ingestion/input-sources.md), and `dimensionsSpec` and `metricsSpec`
include all dimensions and metrics of the input segments by default.
-Compaction tasks fetch all [relevant segments](#compaction-io-configuration)
prior to launching any subtasks, _unless_ the following items are all set. It
is strongly recommended to set all of these items to maximize performance and
minimize disk usage of the `compact` task:
+Compaction tasks typically fetch all [relevant
segments](#compaction-io-configuration) prior to launching any subtasks,
_unless_ the following properties are all set to non-null values. It is
strongly recommended to set them to non-null values to maximize performance and
minimize disk usage of the `compact` task:
-- [`granularitySpec`](#compaction-granularity-spec). All three values must be
set to non-null values: `segmentGranularity`, `queryGranularity`, and `rollup`.
+- [`granularitySpec`](#compaction-granularity-spec), with non-null values for
each of `segmentGranularity`, `queryGranularity`, and `rollup`
- [`dimensionsSpec`](#compaction-dimensions-spec)
- `metricsSpec`
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
