2020-10-26 10:29:30 +00:00
---
toc_priority: 37
toc_title: file
---
2020-03-20 18:20:59 +00:00
# file {#file}
2018-05-14 19:58:49 +00:00
2021-02-14 11:14:39 +00:00
Создаёт таблицу из файла. Данная табличная функция похожа на табличные функции [url ](../../sql-reference/table-functions/url.md ) and [hdfs ](../../sql-reference/table-functions/hdfs.md ).
2021-02-18 18:41:47 +00:00
Функция `file` может использоваться в запросах `SELECT` и `INSERT` при работе с движком таблиц [File ](../../engines/table-engines/special/file.md ).
2021-02-14 11:14:39 +00:00
**Синтаксис**
2018-05-14 19:58:49 +00:00
2020-03-20 18:20:59 +00:00
``` sql
2018-08-15 10:58:37 +00:00
file(path, format, structure)
```
2021-02-14 11:14:39 +00:00
**Параметры**
2018-05-14 19:58:49 +00:00
2021-02-14 11:14:39 +00:00
- `path` — относительный путь до файла от [user_files_path ](../../sql-reference/table-functions/file.md#server_configuration_parameters-user_files_path ). Путь к файлу поддерживает следующие шаблоны в режиме доступа только для чтения `*` , `?` , `{abc,def}` и `{N..M}` , где `N` , `M` — числа, `'abc', 'def'` — строки.
2020-03-21 04:11:51 +00:00
- `format` — [формат ](../../interfaces/formats.md#formats ) файла.
2021-02-14 11:14:39 +00:00
- `structure` — структура таблицы. Формат: `'colunmn1_name column1_ype, column2_name column2_type, ...'` .
2018-05-14 19:58:49 +00:00
2018-08-15 10:58:37 +00:00
**Возвращаемое значение**
2018-08-22 06:23:28 +00:00
Таблица с указанной структурой, предназначенная для чтения или записи данных в указанном файле.
2018-05-14 19:58:49 +00:00
2021-02-14 11:14:39 +00:00
**Примеры**
2018-05-14 19:58:49 +00:00
2018-08-16 08:25:35 +00:00
Настройка `user_files_path` и содержимое файла `test.csv` :
2018-08-15 10:58:37 +00:00
2020-03-20 18:20:59 +00:00
``` bash
2018-08-15 10:58:37 +00:00
$ grep user_files_path /etc/clickhouse-server/config.xml
< user_files_path > /var/lib/clickhouse/user_files/< / user_files_path >
$ cat /var/lib/clickhouse/user_files/test.csv
1,2,3
3,2,1
78,43,45
```
2021-02-14 11:14:39 +00:00
Получение данных из таблицы в файле `test.csv` и выборка первых двух строк из неё:
2018-08-15 10:58:37 +00:00
2020-03-20 18:20:59 +00:00
``` sql
2021-02-14 11:14:39 +00:00
SELECT * FROM file('test.csv', 'CSV', 'column1 UInt32, column2 UInt32, column3 UInt32') LIMIT 2;
2018-08-15 10:58:37 +00:00
```
2020-03-20 18:20:59 +00:00
``` text
2018-08-15 10:58:37 +00:00
┌─column1─┬─column2─┬─column3─┐
│ 1 │ 2 │ 3 │
│ 3 │ 2 │ 1 │
└─────────┴─────────┴─────────┘
2018-05-14 19:58:49 +00:00
```
2018-10-16 10:47:17 +00:00
2021-02-14 11:14:39 +00:00
Получение первых 10 строк таблицы, содержащей 3 столбца типа [UInt32 ](../../sql-reference/data-types/int-uint.md ), из CSV-файла:
``` sql
SELECT * FROM file('test.csv', 'CSV', 'column1 UInt32, column2 UInt32, column3 UInt32') LIMIT 10;
```
Вставка данных из файла в таблицу:
``` sql
INSERT INTO FUNCTION file('test.csv', 'CSV', 'column1 UInt32, column2 UInt32, column3 UInt32') VALUES (1, 2, 3), (3, 2, 1);
SELECT * FROM file('test.csv', 'CSV', 'column1 UInt32, column2 UInt32, column3 UInt32');
```
``` text
┌─column1─┬─column2─┬─column3─┐
│ 1 │ 2 │ 3 │
│ 3 │ 2 │ 1 │
└─────────┴─────────┴─────────┘
```
## Шаблоны в компонентах пути {#globs-in-path}
2019-09-20 11:26:00 +00:00
Шаблоны могут содержаться в нескольких компонентах пути. Обрабатываются только существующие файлы, название которых целиком удовлетворяет шаблону (не только суффиксом или префиксом).
2019-09-04 11:11:30 +00:00
2021-02-14 11:14:39 +00:00
- `*` — заменяет любое количество любых символов кроме `/` , включая отсутствие символов.
- `?` — заменяет ровно один любой символ.
- `{some_string,another_string,yet_another_one}` — заменяет любую из строк `'some_string', 'another_string', 'yet_another_one'` .
- `{N..M}` — заменяет любое число в интервале от `N` до `M` включительно (может содержать ведущие нули).
2019-09-20 11:26:00 +00:00
Конструкция с `{}` аналогична табличной функции [remote ](remote.md ).
**Пример**
2021-02-14 11:14:39 +00:00
Предположим у нас есть несколько файлов с о следующими относительными путями:
2019-09-20 11:26:00 +00:00
2021-02-14 11:14:39 +00:00
- 'some_dir/some_file_1'
- 'some_dir/some_file_2'
- 'some_dir/some_file_3'
- 'another_dir/some_file_1'
- 'another_dir/some_file_2'
- 'another_dir/some_file_3'
2019-09-20 11:26:00 +00:00
2021-02-14 11:14:39 +00:00
Запросим количество строк в этих файлах:
2020-03-20 18:20:59 +00:00
``` sql
2021-02-14 11:14:39 +00:00
SELECT count(*) FROM file('{some,another}_dir/some_file_{1..3}', 'TSV', 'name String, value UInt32');
2019-09-20 11:26:00 +00:00
```
2021-02-14 11:14:39 +00:00
Запросим количество строк во всех файлах этих двух директорий:
2019-09-20 11:26:00 +00:00
2020-03-20 18:20:59 +00:00
``` sql
2021-02-14 11:14:39 +00:00
SELECT count(*) FROM file('{some,another}_dir/*', 'TSV', 'name String, value UInt32');
2019-09-20 11:26:00 +00:00
```
2019-09-04 11:11:30 +00:00
2021-02-14 11:14:39 +00:00
!!! warning "Предупреждение"
2019-09-04 11:11:30 +00:00
Если ваш список файлов содержит интервал с ведущими нулями, используйте конструкцию с фигурными скобками для каждой цифры по отдельности или используйте `?` .
2019-09-20 11:26:00 +00:00
**Пример**
2020-03-20 18:20:59 +00:00
Запрос данных из файлов с именами `file000` , `file001` , … , `file999` :
2019-09-20 11:26:00 +00:00
2020-03-20 18:20:59 +00:00
``` sql
2021-02-14 11:14:39 +00:00
SELECT count(*) FROM file('big_dir/file{0..9}{0..9}{0..9}', 'CSV', 'name String, value UInt32');
2019-09-20 11:26:00 +00:00
```
2019-09-04 11:11:30 +00:00
2020-03-20 18:20:59 +00:00
## Виртуальные столбцы {#virtualnye-stolbtsy}
2020-01-15 07:52:45 +00:00
2021-02-14 11:14:39 +00:00
- `_path` — путь к файлу.
- `_file` — имя файла.
2020-01-15 07:52:45 +00:00
**Смотрите также**
2020-03-21 04:11:51 +00:00
- [Виртуальные столбцы ](index.md#table_engines-virtual_columns )
2020-01-15 07:52:45 +00:00
2021-02-14 11:14:39 +00:00
[Оригинальная статья ](https://clickhouse.tech/docs/ru/sql-reference/table-functions/file/ ) <!--hide-->