Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #58335 from lingtaolf/feature/sparkBar_alias_to_sp…
…arkbar sparkBar as an alias to sparkbar
- Loading branch information
Showing
4 changed files
with
79 additions
and
62 deletions.
There are no files selected for viewing
126 changes: 64 additions & 62 deletions
126
docs/en/sql-reference/aggregate-functions/reference/sparkbar.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,62 +1,64 @@ | ||
--- | ||
slug: /en/sql-reference/aggregate-functions/reference/sparkbar | ||
sidebar_position: 311 | ||
sidebar_label: sparkbar | ||
--- | ||
|
||
# sparkbar | ||
|
||
The function plots a frequency histogram for values `x` and the repetition rate `y` of these values over the interval `[min_x, max_x]`. | ||
Repetitions for all `x` falling into the same bucket are averaged, so data should be pre-aggregated. | ||
Negative repetitions are ignored. | ||
|
||
If no interval is specified, then the minimum `x` is used as the interval start, and the maximum `x` — as the interval end. | ||
Otherwise, values outside the interval are ignored. | ||
|
||
**Syntax** | ||
|
||
``` sql | ||
sparkbar(buckets[, min_x, max_x])(x, y) | ||
``` | ||
|
||
**Parameters** | ||
|
||
- `buckets` — The number of segments. Type: [Integer](../../../sql-reference/data-types/int-uint.md). | ||
- `min_x` — The interval start. Optional parameter. | ||
- `max_x` — The interval end. Optional parameter. | ||
|
||
**Arguments** | ||
|
||
- `x` — The field with values. | ||
- `y` — The field with the frequency of values. | ||
|
||
**Returned value** | ||
|
||
- The frequency histogram. | ||
|
||
**Example** | ||
|
||
Query: | ||
|
||
``` sql | ||
CREATE TABLE spark_bar_data (`value` Int64, `event_date` Date) ENGINE = MergeTree ORDER BY event_date; | ||
|
||
INSERT INTO spark_bar_data VALUES (1,'2020-01-01'), (3,'2020-01-02'), (4,'2020-01-02'), (-3,'2020-01-02'), (5,'2020-01-03'), (2,'2020-01-04'), (3,'2020-01-05'), (7,'2020-01-06'), (6,'2020-01-07'), (8,'2020-01-08'), (2,'2020-01-11'); | ||
|
||
SELECT sparkbar(9)(event_date,cnt) FROM (SELECT sum(value) as cnt, event_date FROM spark_bar_data GROUP BY event_date); | ||
|
||
SELECT sparkbar(9, toDate('2020-01-01'), toDate('2020-01-10'))(event_date,cnt) FROM (SELECT sum(value) as cnt, event_date FROM spark_bar_data GROUP BY event_date); | ||
``` | ||
|
||
Result: | ||
|
||
``` text | ||
┌─sparkbar(9)(event_date, cnt)─┐ | ||
│ ▂▅▂▃▆█ ▂ │ | ||
└──────────────────────────────┘ | ||
┌─sparkbar(9, toDate('2020-01-01'), toDate('2020-01-10'))(event_date, cnt)─┐ | ||
│ ▂▅▂▃▇▆█ │ | ||
└──────────────────────────────────────────────────────────────────────────┘ | ||
``` | ||
|
||
--- | ||
slug: /en/sql-reference/aggregate-functions/reference/sparkbar | ||
sidebar_position: 311 | ||
sidebar_label: sparkbar | ||
--- | ||
|
||
# sparkbar | ||
|
||
The function plots a frequency histogram for values `x` and the repetition rate `y` of these values over the interval `[min_x, max_x]`. | ||
Repetitions for all `x` falling into the same bucket are averaged, so data should be pre-aggregated. | ||
Negative repetitions are ignored. | ||
|
||
If no interval is specified, then the minimum `x` is used as the interval start, and the maximum `x` — as the interval end. | ||
Otherwise, values outside the interval are ignored. | ||
|
||
**Syntax** | ||
|
||
``` sql | ||
sparkbar(buckets[, min_x, max_x])(x, y) | ||
``` | ||
|
||
**Parameters** | ||
|
||
- `buckets` — The number of segments. Type: [Integer](../../../sql-reference/data-types/int-uint.md). | ||
- `min_x` — The interval start. Optional parameter. | ||
- `max_x` — The interval end. Optional parameter. | ||
|
||
**Arguments** | ||
|
||
- `x` — The field with values. | ||
- `y` — The field with the frequency of values. | ||
|
||
**Returned value** | ||
|
||
- The frequency histogram. | ||
|
||
**Example** | ||
|
||
Query: | ||
|
||
``` sql | ||
CREATE TABLE spark_bar_data (`value` Int64, `event_date` Date) ENGINE = MergeTree ORDER BY event_date; | ||
|
||
INSERT INTO spark_bar_data VALUES (1,'2020-01-01'), (3,'2020-01-02'), (4,'2020-01-02'), (-3,'2020-01-02'), (5,'2020-01-03'), (2,'2020-01-04'), (3,'2020-01-05'), (7,'2020-01-06'), (6,'2020-01-07'), (8,'2020-01-08'), (2,'2020-01-11'); | ||
|
||
SELECT sparkbar(9)(event_date,cnt) FROM (SELECT sum(value) as cnt, event_date FROM spark_bar_data GROUP BY event_date); | ||
|
||
SELECT sparkbar(9, toDate('2020-01-01'), toDate('2020-01-10'))(event_date,cnt) FROM (SELECT sum(value) as cnt, event_date FROM spark_bar_data GROUP BY event_date); | ||
``` | ||
|
||
Result: | ||
|
||
``` text | ||
┌─sparkbar(9)(event_date, cnt)─┐ | ||
│ ▂▅▂▃▆█ ▂ │ | ||
└──────────────────────────────┘ | ||
┌─sparkbar(9, toDate('2020-01-01'), toDate('2020-01-10'))(event_date, cnt)─┐ | ||
│ ▂▅▂▃▇▆█ │ | ||
└──────────────────────────────────────────────────────────────────────────┘ | ||
``` | ||
|
||
The alias for this function is sparkBar. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
tests/queries/0_stateless/02955_sparkBar_alias_sparkbar.reference
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
▂▅▂▃▆█ ▂ | ||
▂▅▂▃▆█ ▂ |
12 changes: 12 additions & 0 deletions
12
tests/queries/0_stateless/02955_sparkBar_alias_sparkbar.sql
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
SET allow_experimental_analyzer = 1; | ||
DROP TABLE IF EXISTS spark_bar_test; | ||
|
||
CREATE TABLE spark_bar_test (`value` Int64, `event_date` Date) ENGINE = MergeTree ORDER BY event_date; | ||
|
||
INSERT INTO spark_bar_test VALUES (1,'2020-01-01'), (3,'2020-01-02'), (4,'2020-01-02'), (-3,'2020-01-02'), (5,'2020-01-03'), (2,'2020-01-04'), (3,'2020-01-05'), (7,'2020-01-06'), (6,'2020-01-07'), (8,'2020-01-08'), (2,'2020-01-11'); | ||
|
||
SELECT sparkbar(9)(event_date,cnt) FROM (SELECT sum(value) as cnt, event_date FROM spark_bar_test GROUP BY event_date); | ||
SELECT sparkBar(9)(event_date,cnt) FROM (SELECT sum(value) as cnt, event_date FROM spark_bar_test GROUP BY event_date); | ||
|
||
DROP TABLE IF EXISTS spark_bar_test; | ||
|