mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-11-23 16:12:01 +00:00
7170f3c534
* prefer relative links from root * wip * split aggregate function reference * split system tables
113 lines
6.2 KiB
Markdown
113 lines
6.2 KiB
Markdown
---
|
||
toc_title: SAMPLE
|
||
---
|
||
|
||
# SAMPLE Clause {#select-sample-clause}
|
||
|
||
The `SAMPLE` clause allows for approximated `SELECT` query processing.
|
||
|
||
When data sampling is enabled, the query is not performed on all the data, but only on a certain fraction of data (sample). For example, if you need to calculate statistics for all the visits, it is enough to execute the query on the 1/10 fraction of all the visits and then multiply the result by 10.
|
||
|
||
Approximated query processing can be useful in the following cases:
|
||
|
||
- When you have strict timing requirements (like \<100ms) but you can’t justify the cost of additional hardware resources to meet them.
|
||
- When your raw data is not accurate, so approximation doesn’t noticeably degrade the quality.
|
||
- Business requirements target approximate results (for cost-effectiveness, or to market exact results to premium users).
|
||
|
||
!!! note "Note"
|
||
You can only use sampling with the tables in the [MergeTree](../../../engines/table-engines/mergetree-family/mergetree.md) family, and only if the sampling expression was specified during table creation (see [MergeTree engine](../../../engines/table-engines/mergetree-family/mergetree.md#table_engine-mergetree-creating-a-table)).
|
||
|
||
The features of data sampling are listed below:
|
||
|
||
- Data sampling is a deterministic mechanism. The result of the same `SELECT .. SAMPLE` query is always the same.
|
||
- Sampling works consistently for different tables. For tables with a single sampling key, a sample with the same coefficient always selects the same subset of possible data. For example, a sample of user IDs takes rows with the same subset of all the possible user IDs from different tables. This means that you can use the sample in subqueries in the [IN](../../../sql-reference/operators/in.md) clause. Also, you can join samples using the [JOIN](../../../sql-reference/statements/select/join.md) clause.
|
||
- Sampling allows reading less data from a disk. Note that you must specify the sampling key correctly. For more information, see [Creating a MergeTree Table](../../../engines/table-engines/mergetree-family/mergetree.md#table_engine-mergetree-creating-a-table).
|
||
|
||
For the `SAMPLE` clause the following syntax is supported:
|
||
|
||
| SAMPLE Clause Syntax | Description |
|
||
|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||
| `SAMPLE k` | Here `k` is the number from 0 to 1.</br>The query is executed on `k` fraction of data. For example, `SAMPLE 0.1` runs the query on 10% of data. [Read more](#select-sample-k) |
|
||
| `SAMPLE n` | Here `n` is a sufficiently large integer.</br>The query is executed on a sample of at least `n` rows (but not significantly more than this). For example, `SAMPLE 10000000` runs the query on a minimum of 10,000,000 rows. [Read more](#select-sample-n) |
|
||
| `SAMPLE k OFFSET m` | Here `k` and `m` are the numbers from 0 to 1.</br>The query is executed on a sample of `k` fraction of the data. The data used for the sample is offset by `m` fraction. [Read more](#select-sample-offset) |
|
||
|
||
## SAMPLE K {#select-sample-k}
|
||
|
||
Here `k` is the number from 0 to 1 (both fractional and decimal notations are supported). For example, `SAMPLE 1/2` or `SAMPLE 0.5`.
|
||
|
||
In a `SAMPLE k` clause, the sample is taken from the `k` fraction of data. The example is shown below:
|
||
|
||
``` sql
|
||
SELECT
|
||
Title,
|
||
count() * 10 AS PageViews
|
||
FROM hits_distributed
|
||
SAMPLE 0.1
|
||
WHERE
|
||
CounterID = 34
|
||
GROUP BY Title
|
||
ORDER BY PageViews DESC LIMIT 1000
|
||
```
|
||
|
||
In this example, the query is executed on a sample from 0.1 (10%) of data. Values of aggregate functions are not corrected automatically, so to get an approximate result, the value `count()` is manually multiplied by 10.
|
||
|
||
## SAMPLE N {#select-sample-n}
|
||
|
||
Here `n` is a sufficiently large integer. For example, `SAMPLE 10000000`.
|
||
|
||
In this case, the query is executed on a sample of at least `n` rows (but not significantly more than this). For example, `SAMPLE 10000000` runs the query on a minimum of 10,000,000 rows.
|
||
|
||
Since the minimum unit for data reading is one granule (its size is set by the `index_granularity` setting), it makes sense to set a sample that is much larger than the size of the granule.
|
||
|
||
When using the `SAMPLE n` clause, you don’t know which relative percent of data was processed. So you don’t know the coefficient the aggregate functions should be multiplied by. Use the `_sample_factor` virtual column to get the approximate result.
|
||
|
||
The `_sample_factor` column contains relative coefficients that are calculated dynamically. This column is created automatically when you [create](../../../engines/table-engines/mergetree-family/mergetree.md#table_engine-mergetree-creating-a-table) a table with the specified sampling key. The usage examples of the `_sample_factor` column are shown below.
|
||
|
||
Let’s consider the table `visits`, which contains the statistics about site visits. The first example shows how to calculate the number of page views:
|
||
|
||
``` sql
|
||
SELECT sum(PageViews * _sample_factor)
|
||
FROM visits
|
||
SAMPLE 10000000
|
||
```
|
||
|
||
The next example shows how to calculate the total number of visits:
|
||
|
||
``` sql
|
||
SELECT sum(_sample_factor)
|
||
FROM visits
|
||
SAMPLE 10000000
|
||
```
|
||
|
||
The example below shows how to calculate the average session duration. Note that you don’t need to use the relative coefficient to calculate the average values.
|
||
|
||
``` sql
|
||
SELECT avg(Duration)
|
||
FROM visits
|
||
SAMPLE 10000000
|
||
```
|
||
|
||
## SAMPLE K OFFSET M {#select-sample-offset}
|
||
|
||
Here `k` and `m` are numbers from 0 to 1. Examples are shown below.
|
||
|
||
**Example 1**
|
||
|
||
``` sql
|
||
SAMPLE 1/10
|
||
```
|
||
|
||
In this example, the sample is 1/10th of all data:
|
||
|
||
`[++------------]`
|
||
|
||
**Example 2**
|
||
|
||
``` sql
|
||
SAMPLE 1/10 OFFSET 1/2
|
||
```
|
||
|
||
Here, a sample of 10% is taken from the second half of the data.
|
||
|
||
`[------++------]`
|