This is an automated email from the ASF dual-hosted git repository.
victoria 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 c6dd9dd4af Fix typo in compaction.md (#12774)
c6dd9dd4af is described below
commit c6dd9dd4afa67ba3930fdcbfb1827900a0bd09ba
Author: Katya Macedo <[email protected]>
AuthorDate: Thu Aug 4 16:47:22 2022 -0500
Fix typo in compaction.md (#12774)
---
docs/ingestion/compaction.md | 32 ++++++++++++++++----------------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/docs/ingestion/compaction.md b/docs/ingestion/compaction.md
index d366556fc7..dbd71ac7b6 100644
--- a/docs/ingestion/compaction.md
+++ b/docs/ingestion/compaction.md
@@ -118,17 +118,17 @@ To perform a manual compaction, you submit a compaction
task. Compaction tasks m
|Field|Description|Required|
|-----|-----------|--------|
-|`type`|Task type. Should be `compact`|Yes|
-|`id`|Task id|No|
+|`type`|Task type. Set the value to `compact`.|Yes|
+|`id`|Task ID|No|
|`dataSource`|Data source name to compact|Yes|
|`ioConfig`|I/O configuration for compaction task. See [Compaction I/O
configuration](#compaction-io-configuration) for details.|Yes|
-|`dimensionsSpec`|Custom `dimensionsSpec`. The compaction task uses the
specified `dimensionsSpec` if it exists instead of generating one. See
[Compaction dimensionsSpec](#compaction-dimensions-spec) for details.|No|
-|`transformSpec`|Custom `transformSpec`. The compaction task uses the
specified `transformSpec` rather than using `null`. See [Compaction
transformSpec](#compaction-transform-spec) for details.|No|
-|`metricsSpec`|Custom `metricsSpec`. The compaction task uses the specified
`metricsSpec` rather than generating one.|No|
-|`segmentGranularity`|When set, the compaction task changes the segment
granularity for the given interval. Deprecated. Use `granularitySpec`. |No|
-|`tuningConfig`|[Parallel indexing task
tuningConfig](native-batch.md#tuningconfig).
`awaitSegmentAvailabilityTimeoutMillis` in the tuning config is not supported
for compaction tasks. Leave this parameter at the default value, 0.|No|
-|`granularitySpec`|Custom `granularitySpec`. The compaction task uses the
specified `granularitySpec` rather than generating one. See [Compaction
`granularitySpec`](#compaction-granularity-spec) for details.|No|
-|`context`|[Task context](./tasks.md#context).|No|
+|`dimensionsSpec`|When set, the compaction task uses the specified
`dimensionsSpec` instead of generating one. See [Compaction
dimensionsSpec](#compaction-dimensions-spec) for details.|No|
+|`transformSpec`|When set, the compaction task uses the specified
`transformSpec` rather than using `null`. See [Compaction
transformSpec](#compaction-transform-spec) for details.|No|
+|`metricsSpec`|When set, the compaction task uses the specified `metricsSpec`
rather than generating one.|No|
+|`segmentGranularity`|Deprecated. Use `granularitySpec`.|No|
+|`tuningConfig`|[Tuning configuration](native-batch.md#tuningconfig) for
parallel indexing. `awaitSegmentAvailabilityTimeoutMillis` value is not
supported for compaction tasks. Leave this parameter at the default value,
0.|No|
+|`granularitySpec`|When set, the compaction task uses the specified
`granularitySpec` rather than generating one. See [Compaction
`granularitySpec`](#compaction-granularity-spec) for details.|No|
+|`context`|[Task context](./tasks.md#context)|No|
> Note: Use `granularitySpec` over `segmentGranularity` and only set one of
> these values. If you specify different values for these in the same
> compaction spec, the task fails.
@@ -175,9 +175,9 @@ If you don't specify `granularitySpec`, Druid retains the
original segment and q
The compaction `ioConfig` requires specifying `inputSpec` as follows:
-|Field|Description|Default|Required?|
+|Field|Description|Default|Required|
|-----|-----------|-------|--------|
-|`type`|Task type: `compact`|none|Yes|
+|`type`|Task type. Set the value to `compact`.|none|Yes|
|`inputSpec`|Specification of the target [intervals](#interval-inputspec) or
[segments](#segments-inputspec).|none|Yes|
|`dropExisting`|If `true`, the task replaces all existing segments fully
contained by either of the following:<br>- the `interval` in the `interval`
type `inputSpec`.<br>- the umbrella interval of the `segments` in the `segment`
type `inputSpec`.<br>If compaction fails, Druid does not change any of the
existing segments.<br>**WARNING**: `dropExisting` in `ioConfig` is a beta
feature. |false|No|
@@ -188,15 +188,15 @@ Druid supports two supported `inputSpec` formats:
|Field|Description|Required|
|-----|-----------|--------|
-|`type`|Task type. Should be `interval`|Yes|
-|`interval`|Interval to compact|Yes|
+|`type`|Task type. Set the value to `interval`.|Yes|
+|`interval`|Interval to compact.|Yes|
#### Segments `inputSpec`
|Field|Description|Required|
|-----|-----------|--------|
-|`type`|Task type. Should be `segments`|Yes|
-|`segments`|A list of segment IDs|Yes|
+|`type`|Task type. Set the value to `segments`.|Yes|
+|`segments`|A list of segment IDs.|Yes|
### Compaction dimensions spec
@@ -217,7 +217,7 @@ Druid supports two supported `inputSpec` formats:
|-----|-----------|--------|
|`segmentGranularity`|Time chunking period for the segment granularity.
Defaults to 'null', which preserves the original segment granularity. Accepts
all [Query granularity](../querying/granularities.md) values.|No|
|`queryGranularity`|The resolution of timestamp storage within each segment.
Defaults to 'null', which preserves the original query granularity. Accepts all
[Query granularity](../querying/granularities.md) values.|No|
-|`rollup`|Whether to enable ingestion-time rollup or not. Defaults to 'null',
which preserves the original setting. Note that once data is rollup, individual
records can no longer be recovered. |No|
+|`rollup`|Enables compaction-time rollup. To preserve the original setting,
keep the default value. To enable compaction-time rollup, set the value to
`true`. Once the data is rolled up, you can no longer recover individual
records.|No|
## Learn more
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
