Apache
/
druid
mirror of https://github.com/apache/druid.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Linked back to query granularity docs (#16883) 

* Linked back to query granularity docs

* Update ingestion-spec.md

clairfy about query granularities in the spec.

* Update docs/design/storage.md

Co-authored-by: Charles Smith <techdocsmith@gmail.com>

* Update docs/ingestion/ingestion-spec.md

Co-authored-by: Charles Smith <techdocsmith@gmail.com>

* Update docs/querying/granularities.md

Co-authored-by: Charles Smith <techdocsmith@gmail.com>

* Apply suggestions from code review

---------

Co-authored-by: Charles Smith <techdocsmith@gmail.com>
This commit is contained in:
Hugh Evans 2024-08-23 16:44:19 +01:00 committed by GitHub
parent 0603d5153d
commit 60d4317968
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/design/storage.md
View File

@ -67,7 +67,7 @@ On the Coordinator / Historical side:
Segments all have a four-part identifier with the following components: Segments all have a four-part identifier with the following components:
- Datasource name. - Datasource name.
- Time interval (for the time chunk containing the segment; this corresponds to the `segmentGranularity` specified at ingestion time). - Time interval for the time chunk containing the segment; this corresponds to the `segmentGranularity` specified at ingestion time. Uses the same format as [query granularity](../querying/granularities.md).
- Version number (generally an ISO8601 timestamp corresponding to when the segment set was first started). - Version number (generally an ISO8601 timestamp corresponding to when the segment set was first started).
- Partition number (an integer, unique within a datasource+interval+version; may not necessarily be contiguous). - Partition number (an integer, unique within a datasource+interval+version; may not necessarily be contiguous).

14
docs/ingestion/ingestion-spec.md
View File

@ -301,15 +301,15 @@ An example `metricsSpec` is:
### `granularitySpec` ### `granularitySpec`
The `granularitySpec` is located in `dataSchema` → `granularitySpec` and is responsible for configuring The `granularitySpec`, located in `dataSchema` → `granularitySpec`, specifies the following:
the following operations:
1. Partitioning a datasource into [time chunks](../design/storage.md) (via `segmentGranularity`). 1. `segmentGranularity` to partitioning a datasource into [time chunks](../design/storage.md).
2. Truncating the timestamp, if desired (via `queryGranularity`). 2. `queryGranularity` to optionally truncate the timestamp.
3. Specifying which time chunks of segments should be created, for batch ingestion (via `intervals`). 3. `intervals` to define the time chunks of segments to create for batch ingestion.
4. Specifying whether ingestion-time [rollup](./rollup.md) should be used or not (via `rollup`). 4. `rollup` to enable ingestion-time [rollup](./rollup.md) or not.
Other than `rollup`, these operations are all based on the [primary timestamp](./schema-model.md#primary-timestamp). Other than `rollup`, these operations are all based on the [primary timestamp](./schema-model.md#primary-timestamp).
Use the format from [Query granularities] to specify both `segmentGranualarity` and `queryGranularity`.
An example `granularitySpec` is: An example `granularitySpec` is:
@ -561,4 +561,4 @@ For example:
} }
} }
} }
``` ```

3
docs/querying/granularities.md
View File

@ -30,7 +30,8 @@ sidebar_label: "Granularities"
[SQL documentation](sql-scalar.md#date-and-time-functions). [SQL documentation](sql-scalar.md#date-and-time-functions).
::: :::
Granularity determines how to bucket data across the time dimension, or how to aggregate data by hour, day, minute, etc. Granularity determines how to bucket data across the time dimension, or how to aggregate data by hour, day, minute, etc and defines how it is stored.
The granularity formats here apply also to `segmentGranularity` and `queryGranularity` in the `granularitySpec` section of the the [ingestion spec](../ingestion/ingestion-spec.md#granularityspec).
For example, use time granularities in [native queries](querying.md) to bucket results by time, and in the `dataSchema` \\ [`granularitySpec`](../ingestion/ingestion-spec.md#granularityspec) section of ingestion specifications to segment incoming data. For example, use time granularities in [native queries](querying.md) to bucket results by time, and in the `dataSchema` \\ [`granularitySpec`](../ingestion/ingestion-spec.md#granularityspec) section of ingestion specifications to segment incoming data.