2017-12-11 12:07:26 +00:00
# Прочие функции
2017-03-12 17:58:51 +00:00
2017-12-11 12:07:26 +00:00
## hostName()
2019-06-14 11:26:46 +00:00
2017-03-12 17:58:51 +00:00
Возвращает строку - имя хоста, на котором эта функция была выполнена. При распределённой обработке запроса, это будет имя хоста удалённого сервера, если функция выполняется на удалённом сервере.
2019-12-04 09:17:35 +00:00
## FQDN {#fqdn}
2019-12-28 23:11:02 +00:00
Возвращает полное имя домена.
2019-12-04 09:17:35 +00:00
**Синтаксис**
```sql
fqdn();
```
Эта функция регистронезависимая.
**Возвращаемое значение**
- Полное имя домена.
Тип: `String` .
**Пример**
Запрос:
```sql
SELECT FQDN();
```
Ответ:
```text
┌─FQDN()──────────────────────────┐
│ clickhouse.ru-central1.internal │
└─────────────────────────────────┘
```
2019-06-14 11:26:46 +00:00
## basename
Извлекает конечную часть строки после последнего слэша или бэкслэша. Функция часто используется для извлечения имени файла из пути.
2019-09-23 15:31:46 +00:00
```sql
2019-06-14 11:26:46 +00:00
basename( expr )
```
**Параметры**
- `expr` — Выражение, возвращающее значение типа [String ](../../data_types/string.md ). В результирующем значении все бэкслэши должны быть экранированы.
**Возвращаемое значение**
Строка, содержащая:
- Конечную часть строки после последнего слэша или бэкслэша.
Если входная строка содержит путь, заканчивающийся слэшем или бэкслэшем, например, `/` или `с :\` , функция возвращает пустую строку.
- Исходная строка, если нет слэша или бэкслэша.
**Пример**
```sql
SELECT 'some/long/path/to/file' AS a, basename(a)
```
```text
┌─a──────────────────────┬─basename('some\\long\\path\\to\\file')─┐
│ some\long\path\to\file │ file │
└────────────────────────┴────────────────────────────────────────┘
```
```sql
SELECT 'some\\long\\path\\to\\file' AS a, basename(a)
```
```text
┌─a──────────────────────┬─basename('some\\long\\path\\to\\file')─┐
│ some\long\path\to\file │ file │
└────────────────────────┴────────────────────────────────────────┘
```
```sql
SELECT 'some-file-name' AS a, basename(a)
```
```text
┌─a──────────────┬─basename('some-file-name')─┐
│ some-file-name │ some-file-name │
└────────────────┴────────────────────────────┘
```
2017-12-11 12:07:26 +00:00
## visibleWidth(x)
2019-06-14 11:26:46 +00:00
2017-03-12 17:58:51 +00:00
Вычисляет приблизительную ширину при выводе значения в текстовом (tab-separated) виде на консоль.
Функция используется системой для реализации Pretty форматов.
2018-07-26 14:41:59 +00:00
`NULL` представляется как строка, соответствующая отображению `NULL` в форматах `Pretty` .
2019-09-23 15:31:46 +00:00
```sql
2018-07-26 14:41:59 +00:00
SELECT visibleWidth(NULL)
2019-09-23 15:31:46 +00:00
```
2018-07-26 14:41:59 +00:00
2019-09-23 15:31:46 +00:00
```text
2018-07-26 14:41:59 +00:00
┌─visibleWidth(NULL)─┐
│ 4 │
└────────────────────┘
```
2017-12-11 12:07:26 +00:00
## toTypeName(x)
2017-03-12 17:58:51 +00:00
Возвращает строку, содержащую имя типа переданного аргумента.
2018-07-26 14:41:59 +00:00
Если на вход функции передать `NULL` , то она вернёт тип `Nullable(Nothing)` , что соответствует внутреннему представлению `NULL` в ClickHouse.
2019-06-13 09:04:49 +00:00
## blockSize() {#function-blocksize}
2017-03-12 17:58:51 +00:00
Получить размер блока.
В ClickHouse выполнение запроса всегда идёт по блокам (наборам кусочков столбцов). Функция позволяет получить размер блока, для которого её вызвали.
2017-12-11 12:07:26 +00:00
## materialize(x)
2017-03-12 17:58:51 +00:00
Превращает константу в полноценный столбец, содержащий только одно значение.
В ClickHouse полноценные столбцы и константы представлены в памяти по-разному. Функции по-разному работают для аргументов-констант и обычных аргументов (выполняется разный код), хотя результат почти всегда должен быть одинаковым. Эта функция предназначена для отладки такого поведения.
2017-12-11 12:07:26 +00:00
## ignore(...)
2018-07-26 14:41:59 +00:00
Принимает любые аргументы, в т.ч. `NULL` , всегда возвращает 0.
2017-03-12 17:58:51 +00:00
При этом, аргумент всё равно вычисляется. Это может использоваться для бенчмарков.
2017-12-11 12:07:26 +00:00
## sleep(seconds)
2017-03-12 17:58:51 +00:00
Спит seconds секунд на каждый блок данных. Можно указать как целое число, так и число с плавающей запятой.
2017-12-11 12:07:26 +00:00
## currentDatabase()
2017-03-12 17:58:51 +00:00
Возвращает имя текущей базы данных.
Эта функция может использоваться в параметрах движка таблицы в запросе CREATE TABLE там, где нужно указать базу данных.
2019-09-29 11:15:26 +00:00
## currentUser() {#other_function-currentuser}
Возвращает логин текущего пользователя. При распределенном запросе, возвращается имя пользователя, инициировавшего запрос.
```sql
2019-10-04 07:24:41 +00:00
SELECT currentUser();
2019-09-29 11:15:26 +00:00
```
Алиас: `user()` , `USER()` .
**Возвращаемые значения**
- Логин текущего пользователя.
- При распределенном запросе — логин пользователя, инициировавшего запрос.
Тип: `String` .
**Пример**
Запрос:
```sql
2019-10-04 07:24:41 +00:00
SELECT currentUser();
2019-09-29 11:15:26 +00:00
```
Ответ:
2019-10-04 07:24:41 +00:00
```text
2019-09-29 11:15:26 +00:00
┌─currentUser()─┐
│ default │
└───────────────┘
```
2019-08-13 16:08:12 +00:00
2017-12-11 12:07:26 +00:00
## isFinite(x)
2017-03-12 17:58:51 +00:00
Принимает Float32 или Float64 и возвращает UInt8, равный 1, если аргумент не бесконечный и не NaN, иначе 0.
2017-12-11 12:07:26 +00:00
## isInfinite(x)
2017-03-12 17:58:51 +00:00
Принимает Float32 или Float64 и возвращает UInt8, равный 1, если аргумент бесконечный, иначе 0. Отметим, что в случае NaN возвращается 0.
2017-12-11 12:07:26 +00:00
## isNaN(x)
2017-03-12 17:58:51 +00:00
Принимает Float32 или Float64 и возвращает UInt8, равный 1, если аргумент является NaN, иначе 0.
2017-12-11 12:07:26 +00:00
## hasColumnInTable(\['hostname'\[, 'username'\[, 'password'\]\],\] 'database', 'table', 'column')
2017-03-12 17:58:51 +00:00
Принимает константные строки - имя базы данных, имя таблицы и название столбца. Возвращает константное выражение типа UInt8, равное 1,
2017-07-19 21:01:57 +00:00
если есть столбец, иначе 0. Если задан параметр hostname, проверка будет выполнена на удалённом сервере.
2017-03-12 17:58:51 +00:00
Функция кидает исключение, если таблица не существует.
Для элементов вложенной структуры данных функция проверяет существование столбца. Для самой же вложенной структуры данных функция возвращает 0.
2019-09-25 16:43:10 +00:00
## bar {#function-bar}
2017-10-25 05:27:09 +00:00
2017-03-12 17:58:51 +00:00
Позволяет построить unicode-art диаграмму.
2018-04-28 11:45:37 +00:00
`bar(x, min, max, width)` рисует полосу ширины пропорциональной `(x - min)` и равной `width` символов при `x = max` .
Параметры:
- `x` — Величина для отображения.
- `min, max` — Целочисленные константы, значение должно помещаться в `Int64` .
- `width` — Константа, положительное число, может быть дробным.
2017-03-12 17:58:51 +00:00
Полоса рисуется с точностью до одной восьмой символа.
Пример:
2019-09-23 15:31:46 +00:00
```sql
2017-10-25 05:27:09 +00:00
SELECT
toHour(EventTime) AS h,
count() AS c,
bar(c, 0, 600000, 20) AS bar
FROM test.hits
GROUP BY h
ORDER BY h ASC
```
2019-09-23 15:31:46 +00:00
```text
2017-10-25 05:27:09 +00:00
┌──h─┬──────c─┬─bar────────────────┐
│ 0 │ 292907 │ █████████▋ │
│ 1 │ 180563 │ ██████ │
│ 2 │ 114861 │ ███▋ │
│ 3 │ 85069 │ ██▋ │
│ 4 │ 68543 │ ██▎ │
│ 5 │ 78116 │ ██▌ │
│ 6 │ 113474 │ ███▋ │
│ 7 │ 170678 │ █████▋ │
│ 8 │ 278380 │ █████████▎ │
│ 9 │ 391053 │ █████████████ │
│ 10 │ 457681 │ ███████████████▎ │
│ 11 │ 493667 │ ████████████████▍ │
│ 12 │ 509641 │ ████████████████▊ │
│ 13 │ 522947 │ █████████████████▍ │
│ 14 │ 539954 │ █████████████████▊ │
│ 15 │ 528460 │ █████████████████▌ │
│ 16 │ 539201 │ █████████████████▊ │
│ 17 │ 523539 │ █████████████████▍ │
│ 18 │ 506467 │ ████████████████▊ │
│ 19 │ 520915 │ █████████████████▎ │
│ 20 │ 521665 │ █████████████████▍ │
│ 21 │ 542078 │ ██████████████████ │
│ 22 │ 493642 │ ████████████████▍ │
│ 23 │ 400397 │ █████████████▎ │
└────┴────────┴────────────────────┘
```
2017-12-11 12:07:26 +00:00
## transform
2017-03-12 17:58:51 +00:00
Преобразовать значение согласно явно указанному отображению одних элементов на другие.
Имеется два варианта функции:
2018-12-25 15:25:43 +00:00
1. `transform(x, array_from, array_to, default)`
2017-03-12 17:58:51 +00:00
2017-10-25 05:27:09 +00:00
`x` - что преобразовывать.
2017-03-12 17:58:51 +00:00
2017-10-25 05:27:09 +00:00
`array_from` - константный массив значений для преобразования.
2017-03-12 17:58:51 +00:00
2017-10-25 05:27:09 +00:00
`array_to` - константный массив значений, в которые должны быть преобразованы значения из from.
2017-03-12 17:58:51 +00:00
2017-10-25 05:27:09 +00:00
`default` - какое значение использовать, если x не равен ни одному из значений во from.
2017-03-12 17:58:51 +00:00
2017-10-25 05:27:09 +00:00
`array_from` и `array_to` - массивы одинаковых размеров.
2017-03-12 17:58:51 +00:00
Типы:
2017-10-25 05:27:09 +00:00
`transform(T, Array(T), Array(U), U) -> U`
2017-03-12 17:58:51 +00:00
2017-10-25 05:27:09 +00:00
`T` и `U` - могут быть числовыми, строковыми, или Date или DateTime типами.
2017-03-12 17:58:51 +00:00
При этом, где обозначена одна и та же буква (T или U), могут быть, в случае числовых типов, не совпадающие типы, а типы, для которых есть общий тип.
Например, первый аргумент может иметь тип Int64, а второй - Array(UInt16).
Если значение x равно одному из элементов массива array_from, то возвращает соответствующий (такой же по номеру) элемент массива array_to; иначе возвращает default. Если имеется несколько совпадающих элементов в array_from, то возвращает какой-нибудь из соответствующих.
Пример:
2019-09-23 15:31:46 +00:00
```sql
2017-10-25 05:27:09 +00:00
SELECT
2018-04-23 06:20:21 +00:00
transform(SearchEngineID, [2, 3], ['Yandex', 'Google'], 'Other') AS title,
2017-10-25 05:27:09 +00:00
count() AS c
FROM test.hits
WHERE SearchEngineID != 0
GROUP BY title
ORDER BY c DESC
```
2019-09-23 15:31:46 +00:00
```text
2017-10-25 05:27:09 +00:00
┌─title─────┬──────c─┐
2018-04-23 06:20:21 +00:00
│ Yandex │ 498635 │
2017-10-25 05:27:09 +00:00
│ Google │ 229872 │
2018-04-23 06:20:21 +00:00
│ Other │ 104472 │
2017-10-25 05:27:09 +00:00
└───────────┴────────┘
```
2018-12-25 15:25:43 +00:00
2. `transform(x, array_from, array_to)`
2017-03-12 17:58:51 +00:00
Отличается от первого варианта отсутствующим аргументом default.
Если значение x равно одному из элементов массива array_from, то возвращает соответствующий (такой же по номеру) элемент массива array_to; иначе возвращает x.
Типы:
2017-10-25 05:27:09 +00:00
`transform(T, Array(T), Array(T)) -> T`
2017-03-12 17:58:51 +00:00
Пример:
2019-09-23 15:31:46 +00:00
```sql
2017-10-25 05:27:09 +00:00
SELECT
2018-01-19 14:36:40 +00:00
transform(domain(Referer), ['yandex.ru', 'google.ru', 'vk.com'], ['www.yandex', 'example.com']) AS s,
2017-10-25 05:27:09 +00:00
count() AS c
FROM test.hits
GROUP BY domain(Referer)
ORDER BY count() DESC
LIMIT 10
```
2019-09-23 15:31:46 +00:00
```text
2017-10-25 05:27:09 +00:00
┌─s──────────────┬───────c─┐
│ │ 2906259 │
│ www.yandex │ 867767 │
│ ███████.ru │ 313599 │
│ mail.yandex.ru │ 107147 │
│ ██████.ru │ 100355 │
│ █████████.ru │ 65040 │
│ news.yandex.ru │ 64515 │
│ ██████.net │ 59141 │
│ example.com │ 57316 │
└────────────────┴─────────┘
```
2017-12-11 12:07:26 +00:00
## formatReadableSize(x)
2017-03-12 17:58:51 +00:00
Принимает размер (число байт). Возвращает округленный размер с суффиксом (KiB, MiB и т.д.) в виде строки.
Пример:
2019-09-23 15:31:46 +00:00
```sql
2017-10-25 05:27:09 +00:00
SELECT
arrayJoin([1, 1024, 1024*1024, 192851925]) AS filesize_bytes,
formatReadableSize(filesize_bytes) AS filesize
```
2019-09-23 15:31:46 +00:00
```text
2017-10-25 05:27:09 +00:00
┌─filesize_bytes─┬─filesize───┐
│ 1 │ 1.00 B │
│ 1024 │ 1.00 KiB │
│ 1048576 │ 1.00 MiB │
│ 192851925 │ 183.92 MiB │
└────────────────┴────────────┘
```
2017-12-11 12:07:26 +00:00
## least(a, b)
2017-03-12 17:58:51 +00:00
Возвращает наименьшее значение из a и b.
2017-12-11 12:07:26 +00:00
## greatest(a, b)
2017-03-12 17:58:51 +00:00
Возвращает наибольшее значение из a и b.
2017-12-11 12:07:26 +00:00
## uptime()
2017-03-12 17:58:51 +00:00
Возвращает аптайм сервера в секундах.
2017-12-11 12:07:26 +00:00
## version()
2017-03-12 17:58:51 +00:00
Возвращает версию сервера в виде строки.
2019-06-13 09:04:49 +00:00
## rowNumberInBlock {#function-rownumberinblock}
Возвращает порядковый номер строки в блоке данных. Для каждого блока данных нумерация начинается с 0.
2017-12-11 12:07:26 +00:00
## rowNumberInAllBlocks()
2017-03-12 17:58:51 +00:00
Возвращает порядковый номер строки в блоке данных. Функция учитывает только задействованные блоки данных.
2019-11-12 08:01:46 +00:00
## neighbor {#neighbor}
2019-08-13 13:11:24 +00:00
2019-11-12 08:01:46 +00:00
Функция позволяет получить доступ к значению в колонке `column` , находящемуся на смещении `offset` относительно текущей строки. Является частичной реализацией [оконных функций ](https://en.wikipedia.org/wiki/SQL_window_function ) `LEAD()` и `LAG()` .
2019-08-13 13:11:24 +00:00
2019-11-12 08:01:46 +00:00
**Синтаксис**
```sql
neighbor(column, offset[, default_value])
```
Результат функции зависит от затронутых блоков данных и порядка данных в блоке. Если сделать подзапрос с ORDER BY и вызывать функцию извне подзапроса, можно будет получить ожидаемый результат.
2019-08-13 13:11:24 +00:00
2019-11-12 08:01:46 +00:00
**Параметры**
- `column` — Имя столбца или скалярное выражение.
- `offset` - Смещение от текущей строки `column` . [Int64 ](../../data_types/int_uint.md ).
- `default_value` - Опциональный параметр. Значение, которое будет возвращено, если смещение выходит за пределы блока данных.
**Возвращаемое значение**
2019-12-28 23:11:02 +00:00
- Значение `column` в смещении от текущей строки, если значение `offset` не выходит за пределы блока.
2019-11-12 08:01:46 +00:00
- Значение по умолчанию для `column` , если значение `offset` выходит за пределы блока данных. Если передан параметр `default_value` , то значение берется из него.
Тип: зависит от данных в `column` или переданного значения по умолчанию в `default_value` .
**Пример**
Запрос:
```sql
SELECT number, neighbor(number, 2) FROM system.numbers LIMIT 10;
```
2019-08-13 13:11:24 +00:00
2019-11-12 08:01:46 +00:00
Ответ:
```text
┌─number─┬─neighbor(number, 2)─┐
│ 0 │ 2 │
│ 1 │ 3 │
│ 2 │ 4 │
│ 3 │ 5 │
│ 4 │ 6 │
│ 5 │ 7 │
│ 6 │ 8 │
│ 7 │ 9 │
│ 8 │ 0 │
│ 9 │ 0 │
└────────┴─────────────────────┘
```
Запрос:
```sql
SELECT number, neighbor(number, 2, 999) FROM system.numbers LIMIT 10;
```
Ответ:
```text
┌─number─┬─neighbor(number, 2, 999)─┐
│ 0 │ 2 │
│ 1 │ 3 │
│ 2 │ 4 │
│ 3 │ 5 │
│ 4 │ 6 │
│ 5 │ 7 │
│ 6 │ 8 │
│ 7 │ 9 │
│ 8 │ 999 │
│ 9 │ 999 │
└────────┴──────────────────────────┘
```
Эта функция может использоваться для оценки year-over-year значение показателя:
Запрос:
2019-08-13 13:11:24 +00:00
2019-09-23 15:31:46 +00:00
```sql
2019-08-13 13:11:24 +00:00
WITH toDate('2018-01-01') AS start_date
SELECT
toStartOfMonth(start_date + (number * 32)) AS month,
toInt32(month) % 100 AS money,
2019-08-23 01:31:04 +00:00
neighbor(money, -12) AS prev_year,
2019-08-13 13:11:24 +00:00
round(prev_year / money, 2) AS year_over_year
FROM numbers(16)
```
2019-11-12 08:01:46 +00:00
Ответ:
2019-09-23 15:31:46 +00:00
```text
2019-08-13 13:11:24 +00:00
┌──────month─┬─money─┬─prev_year─┬─year_over_year─┐
│ 2018-01-01 │ 32 │ 0 │ 0 │
│ 2018-02-01 │ 63 │ 0 │ 0 │
│ 2018-03-01 │ 91 │ 0 │ 0 │
│ 2018-04-01 │ 22 │ 0 │ 0 │
│ 2018-05-01 │ 52 │ 0 │ 0 │
│ 2018-06-01 │ 83 │ 0 │ 0 │
│ 2018-07-01 │ 13 │ 0 │ 0 │
│ 2018-08-01 │ 44 │ 0 │ 0 │
│ 2018-09-01 │ 75 │ 0 │ 0 │
│ 2018-10-01 │ 5 │ 0 │ 0 │
│ 2018-11-01 │ 36 │ 0 │ 0 │
│ 2018-12-01 │ 66 │ 0 │ 0 │
│ 2019-01-01 │ 97 │ 32 │ 0.33 │
│ 2019-02-01 │ 28 │ 63 │ 2.25 │
│ 2019-03-01 │ 56 │ 91 │ 1.62 │
│ 2019-04-01 │ 87 │ 22 │ 0.25 │
└────────────┴───────┴───────────┴────────────────┘
```
2017-12-11 12:07:26 +00:00
## runningDifference(x)
2017-03-12 17:58:51 +00:00
Считает разницу между последовательными значениями строк в блоке данных.
Возвращает 0 для первой строки и разницу с предыдущей строкой для каждой последующей строки.
Результат функции зависит от затронутых блоков данных и порядка данных в блоке.
Если сделать подзапрос с ORDER BY и вызывать функцию извне подзапроса, можно будет получить ожидаемый результат.
Пример:
2019-09-23 15:31:46 +00:00
```sql
2017-10-25 05:27:09 +00:00
SELECT
EventID,
EventTime,
runningDifference(EventTime) AS delta
FROM
(
SELECT
EventID,
EventTime
FROM events
WHERE EventDate = '2016-11-24'
ORDER BY EventTime ASC
LIMIT 5
)
```
2019-09-23 15:31:46 +00:00
```text
2017-10-25 05:27:09 +00:00
┌─EventID─┬───────────EventTime─┬─delta─┐
│ 1106 │ 2016-11-24 00:00:04 │ 0 │
│ 1107 │ 2016-11-24 00:00:05 │ 1 │
│ 1108 │ 2016-11-24 00:00:05 │ 0 │
│ 1109 │ 2016-11-24 00:00:09 │ 4 │
│ 1110 │ 2016-11-24 00:00:10 │ 1 │
└─────────┴─────────────────────┴───────┘
```
2019-09-02 20:10:20 +00:00
Обратите внимание — размер блока влияет на результат. С каждым новым блоком состояние `runningDifference` сбрасывается.
2019-09-23 15:31:46 +00:00
```sql
2019-09-02 20:10:20 +00:00
SELECT
number,
runningDifference(number + 1) AS diff
FROM numbers(100000)
WHERE diff != 1
2019-09-23 15:31:46 +00:00
```
```text
2019-09-02 20:10:20 +00:00
┌─number─┬─diff─┐
│ 0 │ 0 │
└────────┴──────┘
┌─number─┬─diff─┐
│ 65536 │ 0 │
└────────┴──────┘
2019-09-23 15:31:46 +00:00
```
```
2019-09-02 23:59:17 +00:00
set max_block_size=100000 -- по умолчанию 65536!
2019-09-02 20:10:20 +00:00
SELECT
number,
runningDifference(number + 1) AS diff
FROM numbers(100000)
WHERE diff != 1
2019-09-23 15:31:46 +00:00
```
```text
2019-09-02 20:10:20 +00:00
┌─number─┬─diff─┐
│ 0 │ 0 │
└────────┴──────┘
```
## runningDifferenceStartingWithFirstValue
Т о же, что и [runningDifference] (./other_functions.md # other_functions-runningdifference), но в первой строке возвращается значение первой строки, а не ноль.
2017-12-11 12:07:26 +00:00
## MACNumToString(num)
2017-05-10 15:33:41 +00:00
Принимает число типа UInt64. Интерпретирует е г о , как MAC-адрес в big endian. Возвращает строку, содержащую соответствующий MAC-адрес в формате AA:BB:CC:DD:EE:FF (числа в шестнадцатеричной форме через двоеточие).
2017-12-11 12:07:26 +00:00
## MACStringToNum(s)
2017-05-10 15:33:41 +00:00
Функция, обратная к MACNumToString. Если MAC адрес в неправильном формате, то возвращает 0.
2017-05-15 14:52:47 +00:00
2017-12-11 12:07:26 +00:00
## MACStringToOUI(s)
2017-05-15 14:52:47 +00:00
Принимает MAC адрес в формате AA:BB:CC:DD:EE:FF (числа в шестнадцатеричной форме через двоеточие). Возвращает первые три октета как число в формате UInt64. Если MAC адрес в неправильном формате, то возвращает 0.
2018-07-26 14:41:59 +00:00
## getSizeOfEnumType
2018-12-12 17:28:00 +00:00
Возвращает количество полей в [Enum ](../../data_types/enum.md ).
2018-07-26 14:41:59 +00:00
2019-09-23 15:31:46 +00:00
```sql
2018-07-26 14:41:59 +00:00
getSizeOfEnumType(value)
```
**Параметры**
- `value` — Значение типа `Enum` .
**Возвращаемые значения**
- Количество полей входного значения типа `Enum` .
- Исключение, если тип не `Enum` .
**Пример**
2019-09-23 15:31:46 +00:00
```sql
2018-07-26 14:41:59 +00:00
SELECT getSizeOfEnumType( CAST('a' AS Enum8('a' = 1, 'b' = 2) ) ) AS x
2019-09-23 15:31:46 +00:00
```
2018-07-26 14:41:59 +00:00
2019-09-23 15:31:46 +00:00
```text
2018-07-26 14:41:59 +00:00
┌─x─┐
│ 2 │
└───┘
```
## toColumnTypeName
Возвращает имя класса, которым представлен тип данных столбца в оперативной памяти.
2019-09-23 15:31:46 +00:00
```sql
2018-07-26 14:41:59 +00:00
toColumnTypeName(value)
```
**Параметры**
- `value` — Значение произвольного типа.
**Возвращаемые значения**
- Строка с именем класса, который используется для представления типа данных `value` в оперативной памяти.
**Пример разницы между `toTypeName` и `toColumnTypeName` **
2019-09-23 15:31:46 +00:00
```sql
SELECT toTypeName(CAST('2018-01-01 01:02:03' AS DateTime))
2018-07-26 14:41:59 +00:00
```
2019-09-23 15:31:46 +00:00
```text
2018-07-26 14:41:59 +00:00
┌─toTypeName(CAST('2018-01-01 01:02:03', 'DateTime'))─┐
│ DateTime │
└─────────────────────────────────────────────────────┘
2019-09-23 15:31:46 +00:00
```
```sql
SELECT toColumnTypeName(CAST('2018-01-01 01:02:03' AS DateTime))
```
2018-07-26 14:41:59 +00:00
2019-09-23 15:31:46 +00:00
```text
2018-07-26 14:41:59 +00:00
┌─toColumnTypeName(CAST('2018-01-01 01:02:03', 'DateTime'))─┐
│ Const(UInt32) │
└───────────────────────────────────────────────────────────┘
```
2018-07-27 13:00:01 +00:00
В примере видно, что тип данных `DateTime` хранится в памяти как `Const(UInt32)` .
2018-07-26 14:41:59 +00:00
## dumpColumnStructure
Выводит развернутое описание структур данных в оперативной памяти
2019-09-23 15:31:46 +00:00
```sql
2018-07-26 14:41:59 +00:00
dumpColumnStructure(value)
```
**Параметры**
- `value` — Значение произвольного типа.
**Возвращаемые значения**
- Строка с описанием структуры, которая используется для представления типа данных `value` в оперативной памяти.
**Пример**
2019-09-23 15:31:46 +00:00
```sql
2018-07-26 14:41:59 +00:00
SELECT dumpColumnStructure(CAST('2018-01-01 01:02:03', 'DateTime'))
2019-09-23 15:31:46 +00:00
```
2018-07-26 14:41:59 +00:00
2019-09-23 15:31:46 +00:00
```text
2018-07-26 14:41:59 +00:00
┌─dumpColumnStructure(CAST('2018-01-01 01:02:03', 'DateTime'))─┐
│ DateTime, Const(size = 1, UInt32(size = 1)) │
└──────────────────────────────────────────────────────────────┘
```
## defaultValueOfArgumentType
Выводит значение по умолчанию для типа данных.
Н е учитывает значения по умолчанию для столбцов, заданные пользователем.
2019-09-23 15:31:46 +00:00
```sql
2018-07-26 14:41:59 +00:00
defaultValueOfArgumentType(expression)
```
**Параметры**
- `expression` — Значение произвольного типа или выражение, результатом которого является значение произвольного типа.
**Возвращаемые значения**
- `0` для чисел;
- Пустая строка для строк;
2018-12-12 17:28:00 +00:00
- `ᴺᵁᴸᴸ` для [Nullable ](../../data_types/nullable.md ).
2018-07-26 14:41:59 +00:00
**Пример**
2019-09-23 15:31:46 +00:00
```sql
SELECT defaultValueOfArgumentType( CAST(1 AS Int8) )
2018-07-26 14:41:59 +00:00
```
2019-09-23 15:31:46 +00:00
```text
2018-07-26 14:41:59 +00:00
┌─defaultValueOfArgumentType(CAST(1, 'Int8'))─┐
│ 0 │
└─────────────────────────────────────────────┘
2019-09-23 15:31:46 +00:00
```
```sql
SELECT defaultValueOfArgumentType( CAST(1 AS Nullable(Int8) ) )
```
2018-07-26 14:41:59 +00:00
2019-09-23 15:31:46 +00:00
```text
2018-07-26 14:41:59 +00:00
┌─defaultValueOfArgumentType(CAST(1, 'Nullable(Int8)'))─┐
│ ᴺᵁᴸᴸ │
└───────────────────────────────────────────────────────┘
```
2019-11-23 12:44:54 +00:00
## indexHint {#indexhint}
2019-12-05 09:51:52 +00:00
2019-11-23 12:44:54 +00:00
Возвращает все данные из диапазона, в который попадают данные, соответствующие указанному выражению.
Переданное выражение не будет вычислено. Выбор диапазона производится по индексу.
2019-11-25 09:35:25 +00:00
Индекс в ClickHouse разреженный, при чтении диапазона в ответ попадают «лишние» соседние данные.
2019-11-23 12:27:44 +00:00
2019-11-23 12:44:54 +00:00
**Синтаксис**
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
```sql
2019-11-25 09:35:25 +00:00
SELECT * FROM table WHERE indexHint(< expression > )
2019-11-23 12:44:54 +00:00
```
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
**Возвращаемое значение**
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
Возвращает диапазон индекса, в котором выполняется заданное условие.
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
Тип: [Uint8 ](https://clickhouse.yandex/docs/ru/data_types/int_uint/#diapazony-uint ).
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
**Пример**
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
Рассмотрим пример с использованием тестовых данных таблицы [ontime ](../../getting_started/example_datasets/ontime.md ).
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
Исходная таблица:
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
```sql
2019-11-25 09:35:25 +00:00
SELECT count() FROM ontime
2019-11-23 12:44:54 +00:00
```
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
```text
2019-11-25 09:35:25 +00:00
┌─count()─┐
│ 4276457 │
└─────────┘
2019-11-23 12:44:54 +00:00
```
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
В таблице есть индексы по полям `(FlightDate, (Year, FlightDate))` .
2019-11-25 09:35:25 +00:00
Выполним выборку по дате, где индекс не используется.
2019-11-23 12:44:54 +00:00
Запрос:
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
```sql
2019-11-25 09:35:25 +00:00
SELECT FlightDate AS k, count() FROM ontime GROUP BY k ORDER BY k
2019-11-23 12:44:54 +00:00
```
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
ClickHouse обработал всю таблицу (`Processed 4.28 million rows`).
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
Результат:
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
```text
2019-11-25 09:35:25 +00:00
┌──────────k─┬─count()─┐
│ 2017-01-01 │ 13970 │
│ 2017-01-02 │ 15882 │
........................
│ 2017-09-28 │ 16411 │
│ 2017-09-29 │ 16384 │
│ 2017-09-30 │ 12520 │
└────────────┴─────────┘
2019-11-23 12:44:54 +00:00
```
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
Для подключения индекса выбираем конкретную дату.
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
Запрос:
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
```sql
2019-11-25 09:35:25 +00:00
SELECT FlightDate AS k, count() FROM ontime WHERE k = '2017-09-15' GROUP BY k ORDER BY k
2019-11-23 12:44:54 +00:00
```
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
При использовании индекса ClickHouse обработал значительно меньшее количество строк (`Processed 32.74 thousand rows`).
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
Результат:
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
```text
2019-11-25 09:35:25 +00:00
┌──────────k─┬─count()─┐
│ 2017-09-15 │ 16428 │
└────────────┴─────────┘
2019-11-23 12:44:54 +00:00
```
2019-11-25 09:35:25 +00:00
Передадим в функцию `indexHint` выражение `k = '2017-09-15'` .
2019-11-23 12:44:54 +00:00
Запрос:
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
```sql
2019-11-25 09:35:25 +00:00
SELECT
FlightDate AS k,
count()
FROM ontime
WHERE indexHint(k = '2017-09-15')
GROUP BY k
ORDER BY k ASC
2019-11-23 12:44:54 +00:00
```
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
ClickHouse применил индекс по аналогии с примером выше (`Processed 32.74 thousand rows`).
Выражение `k = '2017-09-15'` не используется при формировании результата.
2019-11-25 09:35:25 +00:00
Функция `indexHint` позволяет увидеть соседние данные.
2019-11-23 12:44:54 +00:00
Результат:
2019-11-25 09:35:25 +00:00
2019-11-23 12:44:54 +00:00
```text
2019-11-25 09:35:25 +00:00
┌──────────k─┬─count()─┐
│ 2017-09-14 │ 7071 │
│ 2017-09-15 │ 16428 │
│ 2017-09-16 │ 1077 │
│ 2017-09-30 │ 8167 │
└────────────┴─────────┘
2019-11-23 12:44:54 +00:00
```
2018-07-26 14:41:59 +00:00
2019-09-30 09:17:55 +00:00
## replicate {#other_functions-replicate}
2018-07-26 14:41:59 +00:00
Создает массив, заполненный одним значением.
Используется для внутренней реализации [arrayJoin ](array_join.md#functions_arrayjoin ).
2019-09-23 15:31:46 +00:00
```sql
2019-09-30 09:17:55 +00:00
SELECT replicate(x, arr);
2018-07-26 14:41:59 +00:00
```
**Параметры**
- `arr` — Исходный массив. ClickHouse создаёт новый массив такой же длины как исходный и заполняет е г о значением `x` .
- `x` — Значение, которым будет заполнен результирующий массив.
2019-09-30 09:17:55 +00:00
**Возвращаемое значение**
Массив, заполненный значением `x` .
2018-07-26 14:41:59 +00:00
2019-09-30 09:17:55 +00:00
Тип: `Array` .
2018-07-26 14:41:59 +00:00
**Пример**
2019-09-30 09:17:55 +00:00
Запрос:
2019-09-23 15:31:46 +00:00
```sql
2019-09-30 09:17:55 +00:00
SELECT replicate(1, ['a', 'b', 'c']);
2019-09-23 15:31:46 +00:00
```
2018-07-26 14:41:59 +00:00
2019-09-30 09:17:55 +00:00
Ответ:
2019-09-23 15:31:46 +00:00
```text
2018-07-26 14:41:59 +00:00
┌─replicate(1, ['a', 'b', 'c'])─┐
│ [1,1,1] │
└───────────────────────────────┘
```
2018-10-16 10:47:17 +00:00
2019-10-07 19:32:18 +00:00
## filesystemAvailable {#filesystemavailable}
2019-07-18 11:04:45 +00:00
2020-02-02 21:43:39 +00:00
Возвращает объём доступного для записи данных места на файловой системе. Он всегда меньше общего свободного места ([filesystemFree](#filesystemfree)), потому что некоторое пространство зарезервировано для нужд операционной системы.
2019-10-07 19:32:18 +00:00
**Синтаксис**
2019-07-18 11:04:45 +00:00
2019-09-23 15:31:46 +00:00
```sql
2019-07-18 11:04:45 +00:00
filesystemAvailable()
```
**Возвращаемое значение**
2020-02-02 21:43:39 +00:00
- Объём доступного для записи данных места в байтах.
2019-07-18 11:04:45 +00:00
2019-10-07 19:32:18 +00:00
Тип: [UInt64 ](../../data_types/int_uint.md ).
2019-07-18 11:04:45 +00:00
**Пример**
2019-10-07 19:32:18 +00:00
Запрос:
2019-07-18 11:04:45 +00:00
```sql
2019-11-11 11:41:33 +00:00
SELECT formatReadableSize(filesystemAvailable()) AS "Available space", toTypeName(filesystemAvailable()) AS "Type";
2019-07-18 11:04:45 +00:00
```
2019-10-07 19:32:18 +00:00
Ответ:
2019-07-18 11:04:45 +00:00
```text
2019-10-07 19:32:18 +00:00
┌─Available space─┬─Type───┐
2019-11-11 11:41:33 +00:00
│ 30.75 GiB │ UInt64 │
2019-10-07 19:32:18 +00:00
└─────────────────┴────────┘
```
## filesystemFree {#filesystemfree}
2020-02-02 21:43:39 +00:00
Возвращает объём свободного места на файловой системе. Смотрите также `filesystemAvailable` .
2019-10-07 19:32:18 +00:00
**Синтаксис**
```sql
2019-11-11 11:41:33 +00:00
filesystemFree()
2019-10-07 19:32:18 +00:00
```
**Возвращаемое значение**
- Объем свободного места в байтах.
2019-07-18 11:04:45 +00:00
2019-10-07 19:32:18 +00:00
Тип: [UInt64 ](../../data_types/int_uint.md ).
2019-07-18 11:04:45 +00:00
**Пример**
2019-10-07 19:32:18 +00:00
Запрос:
2019-07-18 11:04:45 +00:00
```sql
2019-11-11 11:41:33 +00:00
SELECT formatReadableSize(filesystemFree()) AS "Free space", toTypeName(filesystemFree()) AS "Type";
2019-07-18 11:04:45 +00:00
```
2019-10-07 19:32:18 +00:00
Ответ:
2019-07-18 11:04:45 +00:00
```text
2019-11-11 11:41:33 +00:00
┌─Free space─┬─Type───┐
│ 32.39 GiB │ UInt64 │
└────────────┴────────┘
2019-07-18 11:04:45 +00:00
```
2019-10-07 19:32:18 +00:00
## filesystemCapacity {#filesystemcapacity}
2020-02-02 21:43:39 +00:00
Возвращает информацию о ёмкости файловой системы в байтах. Для оценки должен быть настроен [путь ](../../operations/server_settings/settings.md#server_settings-path ) к каталогу с данными.
2019-10-07 19:32:18 +00:00
**Синтаксис**
```sql
2019-11-11 11:42:53 +00:00
filesystemCapacity()
2019-07-18 11:04:45 +00:00
```
2019-10-07 19:32:18 +00:00
**Возвращаемое значение**
2019-07-18 11:04:45 +00:00
2020-02-02 21:43:39 +00:00
- Информация о ёмкости файловой системы в байтах.
2019-10-07 19:32:18 +00:00
Тип: [UInt64 ](../../data_types/int_uint.md ).
**Пример**
Запрос:
```sql
2019-11-11 11:41:33 +00:00
SELECT formatReadableSize(filesystemCapacity()) AS "Capacity", toTypeName(filesystemCapacity()) AS "Type"
2019-07-18 11:04:45 +00:00
```
2019-10-07 19:32:18 +00:00
Ответ:
2019-07-18 11:04:45 +00:00
2019-10-07 19:32:18 +00:00
```text
2019-11-11 11:41:33 +00:00
┌─Capacity──┬─Type───┐
│ 39.32 GiB │ UInt64 │
└───────────┴────────┘
2019-10-07 19:32:18 +00:00
```
2019-07-18 11:04:45 +00:00
## finalizeAggregation {#function-finalizeaggregation}
Принимает состояние агрегатной функции. Возвращает результат агрегирования.
2019-06-13 09:04:49 +00:00
## runningAccumulate {#function-runningaccumulate}
Принимает на вход состояния агрегатной функции и возвращает столбец с о значениями, которые представляют собой результат мёржа этих состояний для выборки строк из блока от первой до текущей строки. Например, принимает состояние агрегатной функции (например, `runningAccumulate(uniqState(UserID))` ), и для каждой строки блока возвращает результат агрегатной функции после мёржа состояний функции для всех предыдущих строк и текущей. Таким образом, результат зависит от разбиения данных по блокам и от порядка данных в блоке.
2019-10-27 16:33:47 +00:00
## joinGet {#joinget}
2019-07-31 14:49:16 +00:00
2020-01-20 09:48:34 +00:00
Функция позволяет извлекать данные из таблицы таким же образом как из [словаря ](../dicts/index.md ).
2019-07-31 14:49:16 +00:00
2020-01-20 09:48:34 +00:00
Получает данные из таблиц [Join ](../../operations/table_engines/join.md#creating-a-table ) по ключу.
2019-07-31 14:49:16 +00:00
2020-02-02 21:48:18 +00:00
Поддерживаются только таблицы, созданные с `ENGINE = Join(ANY, LEFT, <join_keys>)` .
2019-10-27 16:33:47 +00:00
2020-02-02 21:48:18 +00:00
**Синтаксис**
2019-10-27 16:33:47 +00:00
```sql
joinGet(join_storage_table_name, `value_column` , join_keys)
```
2020-02-02 21:48:18 +00:00
**Параметры**
2019-10-27 16:33:47 +00:00
2020-01-24 10:52:26 +00:00
- `join_storage_table_name` — [идентификатор ](../syntax.md#syntax-identifiers ), который указывает, откуда производится выборка данных. Поиск по идентификатору осуществляется в базе данных по умолчанию (см. конфигурацию `default_database` ). Чтобы переопределить базу данных по умолчанию, используйте команду `USE db_name` , или укажите базу данных и таблицу через разделитель `db_name.db_table` , см. пример.
2019-10-27 16:33:47 +00:00
- `value_column` — столбец, из которого нужно произвести выборку данных.
- `join_keys` — список ключей, по которым производится выборка данных.
**Возвращаемое значение**
Возвращает значение по списку ключей.
2020-02-02 21:48:18 +00:00
Если значения не существует в исходной таблице, вернется `0` или `null` в соответствии с настройками [join_use_nulls ](../../operations/settings/settings.md#join_use_nulls ).
2019-10-27 16:33:47 +00:00
2020-01-24 10:52:26 +00:00
Подробнее о настройке `join_use_nulls` в [операциях Join ](../../operations/table_engines/join.md ).
2019-10-27 16:33:47 +00:00
**Пример**
Входная таблица:
```sql
2020-01-20 09:48:34 +00:00
CREATE DATABASE db_test
2020-01-24 11:38:29 +00:00
CREATE TABLE db_test.id_val(`id` UInt32, `val` UInt32) ENGINE = Join(ANY, LEFT, id) SETTINGS join_use_nulls = 1
2020-01-20 09:48:34 +00:00
INSERT INTO db_test.id_val VALUES (1,11)(2,12)(4,13)
2019-10-27 16:33:47 +00:00
```
```text
┌─id─┬─val─┐
│ 4 │ 13 │
│ 2 │ 12 │
│ 1 │ 11 │
└────┴─────┘
```
Запрос:
```sql
2020-01-24 10:52:26 +00:00
SELECT joinGet(db_test.id_val,'val',toUInt32(number)) from numbers(4) SETTINGS join_use_nulls = 1
2019-10-27 16:33:47 +00:00
```
Результат:
```text
2020-01-20 09:48:34 +00:00
┌─joinGet(db_test.id_val, 'val', toUInt32(number))─┐
│ 0 │
│ 11 │
│ 12 │
│ 0 │
└──────────────────────────────────────────────────┘
2019-10-27 16:33:47 +00:00
```
2019-07-31 14:49:16 +00:00
2019-12-25 17:26:40 +00:00
## modelEvaluate(model_name, ...) {#function-modelevaluate}
2019-07-31 14:49:16 +00:00
2019-12-25 17:26:40 +00:00
Оценивает внешнюю модель.
2019-07-31 14:49:16 +00:00
2019-12-25 17:26:40 +00:00
Принимает на вход имя и аргументы модели. Возвращает Float64.
2019-09-03 00:28:22 +00:00
2019-09-03 01:23:07 +00:00
## throwIf(x\[, custom_message\])
2019-09-03 00:28:22 +00:00
Бросает исключение, если аргумент не равен нулю.
2019-09-03 01:23:07 +00:00
custom_message - необязательный параметр, константная строка, задает текст сообщения о б ошибке.
```sql
SELECT throwIf(number = 3, 'Too many') FROM numbers(10);
2019-09-23 15:31:46 +00:00
```
```text
2019-09-03 01:23:07 +00:00
↙ Progress: 0.00 rows, 0.00 B (0.00 rows/s., 0.00 B/s.) Received exception from server (version 19.14.1):
Code: 395. DB::Exception: Received from localhost:9000. DB::Exception: Too many.
```
2019-09-03 00:28:22 +00:00
2019-10-23 09:31:27 +00:00
## identity {#identity}
2020-02-02 21:26:42 +00:00
Returns the same value that was used as its argument. Used for debugging and testing, allows to cancel using index, and get the query performance of a full scan. When query is analyzed for possible use of index, the analyzer doesn't look inside `identity` functions.
2019-09-03 00:12:14 +00:00
2020-02-02 21:26:42 +00:00
**Syntax**
2019-10-23 09:31:27 +00:00
```sql
2020-02-02 21:26:42 +00:00
identity(x)
2019-10-23 09:31:27 +00:00
```
2020-02-02 21:26:42 +00:00
**Example**
2019-10-23 09:31:27 +00:00
2020-02-02 21:26:42 +00:00
Query:
2019-09-03 00:12:14 +00:00
```sql
SELECT identity(42)
2019-09-23 15:31:46 +00:00
```
2019-09-03 00:12:14 +00:00
2020-02-02 21:26:42 +00:00
Result:
2019-10-23 09:31:27 +00:00
2019-09-23 15:31:46 +00:00
```text
2019-09-03 00:12:14 +00:00
┌─identity(42)─┐
│ 42 │
└──────────────┘
```
2019-12-28 23:11:02 +00:00
## randomPrintableASCII {#randomascii}
2019-08-22 15:13:36 +00:00
2019-12-25 17:26:40 +00:00
Генерирует строку с о случайным набором печатных символов [ASCII ](https://en.wikipedia.org/wiki/ASCII#Printable_characters ).
2019-08-22 15:13:36 +00:00
2019-12-25 17:26:40 +00:00
**Синтаксис**
2019-08-22 15:13:36 +00:00
2019-12-25 17:26:40 +00:00
```sql
2019-12-28 23:11:02 +00:00
randomPrintableASCII(length)
2019-12-25 17:26:40 +00:00
```
**Параметры**
- `length` — Длина результирующей строки. Положительное целое число.
Если передать `length < 0` , то поведение функции не определено.
**Возвращаемое значение**
- Строка с о случайным набором печатных символов [ASCII ](https://en.wikipedia.org/wiki/ASCII#Printable_characters ).
Тип: [String ](../../data_types/string.md )
**Пример**
```sql
2019-12-28 23:11:02 +00:00
SELECT number, randomPrintableASCII(30) as str, length(str) FROM system.numbers LIMIT 3
2019-12-25 17:26:40 +00:00
```
```text
2019-12-28 23:11:02 +00:00
┌─number─┬─str────────────────────────────┬─length(randomPrintableASCII(30))─┐
│ 0 │ SuiCOSTvC0csfABSw=UcSzp2.`rv8x │ 30 │
│ 1 │ 1Ag NlJ &RCN:*>HVPG; PE-nO"SUFD │ 30 │
│ 2 │ /"+< "wUTh:=LjJ Vm!c& hI*m#XTfzz │ 30 │
└────────┴────────────────────────────────┴──────────────────────────────────┘
2019-12-25 17:26:40 +00:00
```
2020-01-30 10:34:55 +00:00
[Оригинальная статья ](https://clickhouse.tech/docs/ru/query_language/functions/other_functions/ ) <!--hide-->