ClickHouse/docs/en/sql-reference/aggregate-functions/reference/sparkbar.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

66 lines
2.2 KiB
Markdown
Raw Normal View History

2021-12-05 16:46:24 +00:00
---
2022-08-28 14:53:34 +00:00
slug: /en/sql-reference/aggregate-functions/reference/sparkbar
sidebar_position: 311
sidebar_label: sparkbar
2021-12-05 16:46:24 +00:00
---
2022-06-02 10:55:18 +00:00
# sparkbar
2021-12-05 16:46:24 +00:00
The function plots a frequency histogram for values `x` and the repetition rate `y` of these values over the interval `[min_x, max_x]`.
2021-12-05 16:46:24 +00:00
If no interval is specified, then the minimum `x` is used as the interval start, and the maximum `x` — as the interval end.
2021-12-05 16:46:24 +00:00
**Syntax**
``` sql
2021-12-06 17:36:42 +00:00
sparkbar(width[, min_x, max_x])(x, y)
2021-12-05 16:46:24 +00:00
```
**Parameters**
- `width` — 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.
2021-12-05 16:46:24 +00:00
**Arguments**
- `x` — The field with values.
- `y` — The field with the frequency of values.
2021-12-05 16:46:24 +00:00
**Returned value**
- The frequency histogram.
**Example**
Query:
``` sql
CREATE TABLE spark_bar_data (`cnt` UInt64,`event_date` Date) ENGINE = MergeTree ORDER BY event_date SETTINGS index_granularity = 8192;
INSERT INTO spark_bar_data VALUES(1,'2020-01-01'),(4,'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 spark_bar_data;
SELECT sparkbar(9,toDate('2020-01-01'),toDate('2020-01-10'))(event_date,cnt) FROM spark_bar_data;
```
Result:
``` text
┌─sparkbar(9)(event_date, cnt)─┐
2021-12-05 17:29:10 +00:00
│ │
│ ▁▅▄▃██▅ ▁ │
│ │
2021-12-05 16:46:24 +00:00
└──────────────────────────────┘
┌─sparkbar(9, toDate('2020-01-01'), toDate('2020-01-10'))(event_date, cnt)─┐
2021-12-05 17:29:10 +00:00
│ │
│▁▄▄▂▅▇█▁ │
│ │
2021-12-05 16:46:24 +00:00
└──────────────────────────────────────────────────────────────────────────┘
```