> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-fix-nav-issues.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> Движок таблицы, предоставляющий табличный интерфейс для выполнения `SELECT` из файлов и `INSERT` в файлы, аналогично табличной функции s3. Используйте `file()` при работе с локальными файлами, а `s3()` — при работе с бакетами в объектных хранилищах, таких как S3, GCS или MinIO.

# Табличная функция file

export const CloudNotSupportedBadge = () => {
  return <div className="cloudNotSupportedBadge">
            <div className="cloudNotSupportedIcon">
            <svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
                <path strokeWidth="1.5" d="M6.33366 12.6666L12.3739 12.6667C13.6593 12.6667 14.7073 11.6187 14.7073 10.3334C14.7073 9.04804 13.6593 8.00003 12.3739 8.00003C12.3739 8.00003 12.3337 7.66659 12.0003 7.33325M10.667 5.33322C8.00033 2.33325 4.45395 4.78537 4.14195 6.68203C2.55728 6.7627 1.29395 8.06203 1.29395 9.6667C1.29395 11.3234 2.66699 12.6666 4.00033 12.6666" stroke="currentColor" strokeLinecap="round" strokeLinejoin="round" />
                <path strokeWidth="1.5" d="M2.66699 14L12.0003 4.66663" stroke="currentColor" strokeLinecap="round" strokeLinejoin="round" />
            </svg>

        </div>
            Not supported in ClickHouse Cloud
        </div>;
};

export const ExperimentalBadge = () => {
  return <div className="experimentalBadge">
            <div className="experimentalIcon">
            <svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
                <path strokeWidth="1.25" d="M5.5 2H10.5" stroke="currentColor" strokeLinecap="round" strokeLinejoin="round" />
                <path strokeWidth="1.25" d="M9.50015 2V6.19625L13.4283 12.7425C13.4738 12.8183 13.4985 12.9049 13.4996 12.9934C13.5008 13.0818 13.4785 13.169 13.435 13.246C13.3914 13.323 13.3283 13.3871 13.2519 13.4317C13.1755 13.4764 13.0886 13.4999 13.0002 13.5H3.00015C2.91164 13.5 2.8247 13.4766 2.74822 13.432C2.67174 13.3874 2.60847 13.3233 2.56487 13.2463C2.52126 13.1693 2.49889 13.082 2.50004 12.9935C2.50119 12.905 2.52582 12.8184 2.5714 12.7425L6.50015 6.19625V2" stroke="currentColor" strokeLinecap="round" strokeLinejoin="round" />
                <path strokeWidth="1.25" d="M4.47656 9.56754C5.30344 9.41254 6.47656 9.47942 7.99969 10.25C10.0153 11.2707 11.4216 11.0569 12.2184 10.7282" stroke="currentColor" strokeLinecap="round" strokeLinejoin="round" />
            </svg>
        </div>
            Experimental feature. <u><a href="/docs/beta-and-experimental-features#experimental-features">Learn more.</a></u>
        </div>;
};

Движок таблицы, предоставляющий табличный интерфейс для выполнения `SELECT` из файлов и `INSERT` в файлы, аналогично табличной функции [s3](/ru/reference/functions/table-functions/url). Используйте `file()` при работе с локальными файлами, а `s3()` — при работе с бакетами в объектных хранилищах, таких как S3, GCS или MinIO.

Функцию `file` можно использовать в запросах `SELECT` и `INSERT` для чтения из файлов и записи в них.

<div id="syntax">
  ## Синтаксис
</div>

```sql theme={null}
file([path_to_archive ::] path [,format] [,structure] [,compression])
```

Для запросов `SELECT` параметр `path` также может быть выражением, возвращающим `Array(String)`:

```sql theme={null}
file(['file1.csv', 'file2.csv'], 'CSV', 'column1 UInt32, column2 UInt32')
```

<div id="arguments">
  ## Аргументы
</div>

| Параметр          | Описание                                                                                                                                                                                                                                                                                                                                         |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `path`            | Относительный путь к файлу из [user\_files\_path](/ru/reference/settings/server-settings/settings#user_files_path) или `Array(String)` путей в запросах `SELECT`. В режиме только для чтения поддерживаются следующие [глоб-шаблоны](#globs-in-path): `*`, `?`, `{abc,def}` (где `'abc'` и `'def'` — строки) и `{N..M}` (где `N` и `M` — числа). |
| `path_to_archive` | Относительный путь к архиву zip/tar/7z. Поддерживает те же глоб-шаблоны, что и `path`.                                                                                                                                                                                                                                                           |
| `format`          | [Формат](/ru/reference/formats) файла.                                                                                                                                                                                                                                                                                                           |
| `structure`       | Структура таблицы. Формат: `'column1_name column1_type, column2_name column2_type, ...'`.                                                                                                                                                                                                                                                        |
| `compression`     | Существующий тип сжатия при использовании в запросе `SELECT` или требуемый тип сжатия при использовании в запросе `INSERT`. Поддерживаемые типы сжатия: `gz`, `br`, `xz`, `zst`, `lz4` и `bz2`.                                                                                                                                                  |

<Tip>
  Если аргумент `structure` опущен, ClickHouse определяет схему по самому формату.
  Для разных форматов используются разные имена столбцов и типы по умолчанию.
  Чтобы посмотреть схему для конкретного формата, используйте [`DESC`](/ru/reference/statements/describe-table) с табличной функцией [`format`](/ru/reference/functions/table-functions/format).

  Например:

  ```sql theme={null}
  DESC format(LineAsString, 'Hello\nWorld')
  ```

  ```response theme={null}
  ┌─name─┬─type───┬─default_type─┬─default_expression─┬─comment─┬─codec_expression─┬─ttl_expression─┐
  │ line │ String │              │                    │         │                  │                │
  └──────┴────────┴──────────────┴────────────────────┴─────────┴──────────────────┴────────────────┘
  ```
</Tip>

<div id="returned_value">
  ## Возвращаемое значение
</div>

Таблица для чтения данных из файла или записи данных в файл.

<div id="examples-for-writing-to-a-file">
  ## Примеры записи в файл
</div>

<div id="write-to-a-tsv-file">
  ### Запись в файл в формате TSV
</div>

```sql theme={null}
INSERT INTO TABLE FUNCTION
file('test.tsv', 'TSV', 'column1 UInt32, column2 UInt32, column3 UInt32')
VALUES (1, 2, 3), (3, 2, 1), (1, 3, 2)
```

В результате данные записываются в файл `test.tsv`:

```bash theme={null}
# cat /var/lib/clickhouse/user_files/test.tsv
1    2    3
3    2    1
1    3    2
```

<div id="partitioned-write-to-multiple-tsv-files">
  ### Запись в несколько файлов в формате TSV с разбиением на партиции
</div>

Если при вставке данных в табличную функцию типа `file()` указать выражение `PARTITION BY`, для каждой партиции будет создан отдельный файл. Разбиение данных на отдельные файлы помогает повысить производительность операций чтения.

```sql theme={null}
INSERT INTO TABLE FUNCTION
file('test_{_partition_id}.tsv', 'TSV', 'column1 UInt32, column2 UInt32, column3 UInt32')
PARTITION BY column3
VALUES (1, 2, 3), (3, 2, 1), (1, 3, 2)
```

В результате данные записываются в три файла: `test_1.tsv`, `test_2.tsv` и `test_3.tsv`.

```bash theme={null}
# cat /var/lib/clickhouse/user_files/test_1.tsv
3    2    1

# cat /var/lib/clickhouse/user_files/test_2.tsv
1    3    2

# cat /var/lib/clickhouse/user_files/test_3.tsv
1    2    3
```

<div id="examples-for-reading-from-a-file">
  ## Примеры чтения из файла
</div>

<div id="select-from-a-csv-file">
  ### SELECT из CSV-файла
</div>

Сначала задайте `user_files_path` в конфигурации сервера и подготовьте файл `test.csv`:

```bash theme={null}
$ 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
```

Затем загрузите данные из `test.csv` в таблицу и выберите первые две строки:

```sql theme={null}
SELECT * FROM
file('test.csv', 'CSV', 'column1 UInt32, column2 UInt32, column3 UInt32')
LIMIT 2;
```

```text theme={null}
┌─column1─┬─column2─┬─column3─┐
│       1 │       2 │       3 │
│       3 │       2 │       1 │
└─────────┴─────────┴─────────┘
```

<div id="inserting-data-from-a-file-into-a-table">
  ### Вставка данных из файла в таблицу
</div>

```sql theme={null}
INSERT INTO FUNCTION
file('test.csv', 'CSV', 'column1 UInt32, column2 UInt32, column3 UInt32')
VALUES (1, 2, 3), (3, 2, 1);
```

```sql theme={null}
SELECT * FROM
file('test.csv', 'CSV', 'column1 UInt32, column2 UInt32, column3 UInt32');
```

```text theme={null}
┌─column1─┬─column2─┬─column3─┐
│       1 │       2 │       3 │
│       3 │       2 │       1 │
└─────────┴─────────┴─────────┘
```

Чтение данных из `table.csv`, находящегося в `archive1.zip` и/или `archive2.zip`:

```sql theme={null}
SELECT * FROM file('user_files/archives/archive{1..2}.zip :: table.csv');
```

<div id="globs-in-path">
  ## Глоб-шаблоны в пути
</div>

В путях можно использовать глоб-шаблоны. Файлы должны соответствовать всему шаблону пути, а не только суффиксу или префиксу. Есть одно исключение: если путь указывает на существующий
каталог и не содержит глоб-шаблонов, к пути неявно добавляется `*`, чтобы
выбрать все файлы в каталоге.

* `*` — Обозначает произвольное количество символов, кроме `/`, включая пустую строку.
* `?` — Обозначает один произвольный символ.
* `{some_string,another_string,yet_another_one}` — Подставляет любую из строк `'some_string', 'another_string', 'yet_another_one'`. Строки могут содержать символ `/`.
* `{N..M}` — Обозначает любое число `>= N` и `<= M`.
* `**` - Обозначает все файлы в папке и во всех её вложенных папках.

Конструкции с `{}` аналогичны конструкциям в табличной функции [remote](/ru/reference/functions/table-functions/remote) и [hdfs](/ru/reference/functions/table-functions/hdfs).

<div id="examples">
  ## Примеры
</div>

**Пример**

Предположим, есть следующие файлы с такими относительными путями:

* `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`

Выполните запрос, чтобы получить общее количество строк во всех файлах:

```sql theme={null}
SELECT count(*) FROM file('{some,another}_dir/some_file_{1..3}', 'TSV', 'name String, value UInt32');
```

Альтернативное выражение пути с тем же результатом:

```sql theme={null}
SELECT count(*) FROM file('{some,another}_dir/*', 'TSV', 'name String, value UInt32');
```

Выполните запрос, чтобы получить общее количество строк в `some_dir`, используя неявный `*`:

```sql theme={null}
SELECT count(*) FROM file('some_dir', 'TSV', 'name String, value UInt32');
```

<Note>
  Если в вашем списке файлов есть диапазоны чисел с ведущими нулями, используйте конструкцию с фигурными скобками для каждой цифры отдельно или символ `?`.
</Note>

**Пример**

Запросите общее количество строк в файлах с именами `file000`, `file001`, ... , `file999`:

```sql theme={null}
SELECT count(*) FROM file('big_dir/file{0..9}{0..9}{0..9}', 'CSV', 'name String, value UInt32');
```

**Пример**

Рекурсивно запросите общее количество строк во всех файлах внутри каталога `big_dir/`:

```sql theme={null}
SELECT count(*) FROM file('big_dir/**', 'CSV', 'name String, value UInt32');
```

**Пример**

Рекурсивно получите общее количество строк из всех файлов `file002` во всех папках каталога `big_dir/`:

```sql theme={null}
SELECT count(*) FROM file('big_dir/**/file002', 'CSV', 'name String, value UInt32');
```

<div id="virtual-columns">
  ## Виртуальные столбцы
</div>

* `_path` — Путь к файлу. Тип: `LowCardinality(String)`.
* `_file` — Имя файла. Тип: `LowCardinality(String)`.
* `_size` — Размер файла в байтах. Тип: `Nullable(UInt64)`. Если размер файла неизвестен, значение — `NULL`.
* `_time` — Время последнего изменения файла. Тип: `Nullable(DateTime)`. Если время неизвестно, значение — `NULL`.

<div id="hive-style-partitioning">
  ## Настройка use\_hive\_partitioning
</div>

Когда параметр `use_hive_partitioning` установлен в 1, ClickHouse определяет партиционирование в стиле Hive в пути (`/name=value/`) и позволяет использовать столбцы партиции в запросе как виртуальные столбцы. Эти виртуальные столбцы будут иметь те же имена, что и в пути с партициями.

**Пример**

Использование виртуального столбца, созданного с помощью партиционирования в стиле Hive

```sql theme={null}
SELECT * FROM file('data/path/date=*/country=*/code=*/*.parquet') WHERE date > '2020-01-01' AND country = 'Netherlands' AND code = 42;
```

<div id="settings">
  ## Настройки
</div>

| Настройка                                                                                                                       | Описание                                                                                                                                                                                                |
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [engine\_file\_empty\_if\_not\_exists](/ru/reference/settings/session-settings#engine_file_empty_if_not_exists)                 | позволяет возвращать пустой набор данных из несуществующего файла. По умолчанию отключено.                                                                                                              |
| [engine\_file\_truncate\_on\_insert](/ru/reference/settings/session-settings#engine_file_truncate_on_insert)                    | позволяет очищать файл перед вставкой данных в него. По умолчанию отключено.                                                                                                                            |
| [engine\_file\_allow\_create\_multiple\_files](/ru/reference/settings/session-settings#engine_file_allow_create_multiple_files) | позволяет создавать новый файл при каждой вставке, если формат имеет суффикс. По умолчанию отключено.                                                                                                   |
| [engine\_file\_skip\_empty\_files](/ru/reference/settings/session-settings#engine_file_skip_empty_files)                        | позволяет пропускать пустые файлы при чтении. По умолчанию отключено.                                                                                                                                   |
| [storage\_file\_read\_method](/ru/reference/settings/session-settings#engine_file_empty_if_not_exists)                          | метод чтения данных из файла хранилища; одно из следующих значений: read, pread, mmap (только для clickhouse-local). Значение по умолчанию: `pread` для clickhouse-server, `mmap` для clickhouse-local. |

<div id="related">
  ## См. также
</div>

* [Виртуальные столбцы](/ru/reference/engines/table-engines#table_engines-virtual_columns)
* [Переименование файлов после обработки](/ru/reference/settings/session-settings#rename_files_after_processing)