Табличные функции

Документация по табличным функциям

Табличные функции — это способы создания таблиц.

Страница	Описание
azureBlobStorage	Предоставляет табличный интерфейс для выбора и вставки файлов в Azure Blob Storage. Аналогична функции s3.
azureBlobStorageCluster	Позволяет параллельно обрабатывать файлы из Azure Blob Storage на множестве узлов указанного кластера.
clusterAllReplicas	Позволяет обращаться ко всем сегментам кластера (настроенным в разделе remote_servers) без создания distributed таблицы.
deltaLake	Предоставляет табличный интерфейс только для чтения для таблиц Delta Lake в Amazon S3.
deltaLakeCluster	Это расширение табличной функции deltaLake.
dictionary	Отображает данные словаря в виде таблицы ClickHouse. Работает так же, как движок Dictionary.
executable	Табличная функция executable создаёт таблицу на основе вывода пользовательской функции (UDF), определённой в скрипте, который выводит строки в stdout.
file	Движок таблицы, предоставляющий табличный интерфейс для SELECT из файлов и INSERT в файлы, аналогично табличной функции s3. Используйте file() при работе с локальными файлами, а s3() — при работе с бакетами в Объектном хранилище, например S3, GCS или MinIO.
fileCluster	Обеспечивает одновременную обработку файлов, соответствующих указанному пути, на нескольких узлах кластера. Инициатор устанавливает connections с воркер-узлами, разворачивает глоб-шаблоны в пути к файлам и делегирует задачи чтения файлов воркер-узлам. Каждый воркер-узел запрашивает у инициатора следующий файл для обработки и повторяет это до завершения всех задач (то есть пока не будут прочитаны все файлы).
filesystem	Предоставляет доступ к файловой системе для вывода списка файлов и возврата их метаданных и содержимого.
format	Разбирает данные из аргументов в соответствии с указанным входным форматом. Если аргумент structure не указан, она извлекается из данных.
gcs	Предоставляет табличный интерфейс для SELECT и INSERT данных из Google Cloud Storage. Требуется роль IAM Storage Object User.
fuzzQuery	Искажает заданную строку запроса случайными вариациями.
fuzzJSON	Искажает строку JSON случайными вариациями.
generateRandom	Генерирует случайные данные по заданной схеме. Позволяет заполнять ими тестовые таблицы. Поддерживаются не все типы.
mergeTreeTextIndex	Представляет словарь текстового индекса в таблице MergeTree. Может использоваться для интроспекции.
mergeTreeProjection	Представляет содержимое одной из проекций в таблицах MergeTree. Может использоваться для интроспекции.
mergeTreeIndex	Представляет содержимое файлов индекса и marks таблиц MergeTree. Может использоваться для интроспекции.
hdfs	Создаёт таблицу из файлов в HDFS. Эта табличная функция аналогична табличным функциям url и file.
hdfsCluster	Позволяет параллельно обрабатывать файлы из HDFS на множестве узлов указанного кластера.
hudi	Предоставляет табличный интерфейс только для чтения для таблиц Apache Hudi в Amazon S3.
ytsaurus	Эта табличная функция позволяет читать данные из кластера YTsaurus.
hudiCluster Table Function	Расширение табличной функции hudi. Позволяет параллельно обрабатывать файлы из таблиц Apache Hudi в Amazon S3 на множестве узлов указанного кластера.
iceberg	Предоставляет табличный интерфейс только для чтения для таблиц Apache Iceberg в Amazon S3, Azure, HDFS или локальном хранилище.
paimon	Предоставляет табличный интерфейс только для чтения для таблиц Apache Paimon в Amazon S3, Azure, HDFS или локальном хранилище.
icebergCluster	Расширение табличной функции iceberg, которое позволяет параллельно обрабатывать файлы из Apache Iceberg на множестве узлов указанного кластера.
paimonCluster	Расширение табличной функции paimon, которое позволяет параллельно обрабатывать файлы из Apache Paimon на множестве узлов указанного кластера.
input	Табличная функция, позволяющая эффективно преобразовывать и вставлять данные, отправленные на сервер с заданной структурой, в таблицу с другой структурой.
jdbc	Возвращает таблицу, подключённую через JDBC driver.
merge	Создаёт временную таблицу Merge. Структура определяется на основе базовых таблиц путём объединения их столбцов и вывода общих типов.
mongodb	Позволяет выполнять SELECT-запросы к данным, хранящимся на удалённом сервере MongoDB.
mysql	Позволяет выполнять SELECT- и INSERT-запросы к данным, хранящимся на удалённом сервере MySQL.
null	Создаёт временную таблицу с указанной структурой, используя движок таблицы Null. Функция используется для удобства написания тестов и демонстраций.
timeSeriesMetrics	timeSeriesMetrics возвращает таблицу метрик, которую использует таблица db_name.time_series_table с движком таблицы TimeSeries.
timeSeriesSelector	Считывает временные ряды из таблицы TimeSeries, отфильтрованные селектором, с временными метками в указанном интервале.
timeSeriesTags	Табличная функция timeSeriesTags возвращает таблицу тегов, которую использует таблица db_name.time_series_table с движком таблицы TimeSeries.
prometheusQueryRange	Вычисляет запрос Prometheus, используя данные из таблицы TimeSeries.
zeros	Используется в целях тестирования как самый быстрый способ сгенерировать много строк. Аналогична системным таблицам system.zeros и system.zeros_mt.
primes	Возвращает таблицу с единственным столбцом prime, содержащим простые числа.
timeSeriesData	timeSeriesData возвращает таблицу данных, которую использует таблица db_name.time_series_table с движком таблицы TimeSeries.
numbers	Возвращает таблицу с единственным столбцом number, содержащим последовательность целых чисел.
prometheusQuery	Вычисляет запрос Prometheus, используя данные из таблицы TimeSeries.
generate_series (generateSeries)	Возвращает таблицу с единственным столбцом generate_series (UInt64), содержащим целые числа от start до stop включительно.
odbc	Возвращает таблицу, подключённую через ODBC.
postgresql	Позволяет выполнять SELECT- и INSERT-запросы к данным, хранящимся на удалённом сервере PostgreSQL.
redis	Эта табличная функция позволяет интегрировать ClickHouse с Redis.
remote, remoteSecure	Табличная функция remote позволяет обращаться к удалённым серверам на лету, то есть без создания distributed таблицы. Табличная функция remoteSecure аналогична remote, но работает по защищённому соединению.
s3 Table Function	Предоставляет табличный интерфейс для выборки и вставки файлов в Amazon S3 и Google Cloud Storage. Эта табличная функция похожа на функцию hdfs, но предоставляет возможности, специфичные для S3.
s3Cluster	Расширение табличной функции s3, которое позволяет параллельно обрабатывать файлы из Amazon S3 и Google Cloud Storage на множестве узлов в указанном кластере.
sqlite	Позволяет выполнять запросы к данным, хранящимся в базе данных SQLite.
arrowFlight	Позволяет выполнять запросы к данным, доступным через сервер Apache Arrow Flight.
url	Создаёт таблицу из URL с указанными format и structure
urlCluster	Позволяет параллельно обрабатывать файлы по URL с множества узлов в указанном кластере.
view	Преобразует подзапрос в таблицу. Функция реализует представления.
values	Создаёт временное хранилище, которое заполняет столбцы значениями.
loop	Табличная функция loop в ClickHouse используется для возврата результатов запроса в бесконечном цикле.

​

Использование

Табличные функции можно использовать в секции FROM запроса SELECT. Например, с помощью табличной функции file можно выполнить SELECT данных из файла на локальном компьютере.

Query

echo "1, 2, 3" > example.csv

Response

./clickhouse client
:) SELECT * FROM file('example.csv')
┌─c1─┬─c2─┬─c3─┐
│  1 │  2 │  3 │
└────┴────┴────┘

Вы также можете использовать табличные функции для создания временной таблицы, доступной только в рамках текущего запроса. Например:

Query

SELECT * FROM generateSeries(1,5);

Response

┌─generate_series─┐
│               1 │
│               2 │
│               3 │
│               4 │
│               5 │
└─────────────────┘

Таблица удаляется после завершения запроса.

Табличные функции можно использовать для создания таблиц со следующим синтаксисом:

Query

CREATE TABLE [IF NOT EXISTS] [db.]table_name AS table_function()

Например:

Query

CREATE TABLE series AS generateSeries(1, 5);
SELECT * FROM series;

Response

┌─generate_series─┐
│               1 │
│               2 │
│               3 │
│               4 │
│               5 │
└─────────────────┘

Наконец, табличные функции можно использовать для INSERT в таблицу. Например, мы можем снова использовать табличную функцию file, чтобы записать содержимое таблицы, которую создали в предыдущем примере, в файл на диске:

Query

INSERT INTO FUNCTION file('numbers.csv', 'CSV') SELECT * FROM series;

Query

cat numbers.csv
1
2
3
4
5

Вы не сможете использовать табличные функции, если параметр allow_ddl отключён.