2018-05-14 19:58:49 +00:00
# file
2019-09-20 11:26:00 +00:00
Creates a table from a file. This table function is similar to [url ](url.md ) and [hdfs ](hdfs.md ) ones.
2018-05-14 19:58:49 +00:00
2019-09-23 15:31:46 +00:00
```sql
2018-10-19 11:25:22 +00:00
file(path, format, structure)
```
**Input parameters**
2019-09-04 11:11:30 +00:00
- `path` — The relative path to the file from [user_files_path ](../../operations/server_settings/settings.md#server_settings-user_files_path ). Path to file support following globs in readonly mode: `*` , `?` , `{abc,def}` and `{N..M}` where `N` , `M` — numbers, ``'abc', 'def'` — strings.
2018-10-19 11:25:22 +00:00
- `format` — The [format ](../../interfaces/formats.md#formats ) of the file.
2019-09-03 14:23:51 +00:00
- `structure` — Structure of the table. Format `'column1_name column1_type, column2_name column2_type, ...'` .
2018-05-14 19:58:49 +00:00
2018-10-19 11:25:22 +00:00
**Returned value**
2018-05-14 19:58:49 +00:00
2018-10-19 11:25:22 +00:00
A table with the specified structure for reading or writing data in the specified file.
2018-05-14 19:58:49 +00:00
**Example**
2018-10-19 11:25:22 +00:00
Setting `user_files_path` and the contents of the file `test.csv` :
```bash
$ 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
```
Table from`test.csv` and selection of the first two rows from it:
```sql
SELECT *
FROM file('test.csv', 'CSV', 'column1 UInt32, column2 UInt32, column3 UInt32')
LIMIT 2
```
2019-09-23 15:31:46 +00:00
```text
2018-10-19 11:25:22 +00:00
┌─column1─┬─column2─┬─column3─┐
│ 1 │ 2 │ 3 │
│ 3 │ 2 │ 1 │
└─────────┴─────────┴─────────┘
```
2019-09-23 15:31:46 +00:00
```sql
2018-09-06 18:15:16 +00:00
-- getting the first 10 lines of a table that contains 3 columns of UInt32 type from a CSV file
SELECT * FROM file('test.csv', 'CSV', 'column1 UInt32, column2 UInt32, column3 UInt32') LIMIT 10
2018-05-14 19:58:49 +00:00
```
2018-10-16 10:47:17 +00:00
2019-09-04 11:11:30 +00:00
**Globs in path**
2019-09-20 11:26:00 +00:00
Multiple path components can have globs. For being processed file should exists and matches to the whole path pattern (not only suffix or prefix).
2019-09-04 11:11:30 +00:00
2019-09-23 15:12:43 +00:00
- `*` — Substitutes any number of any characters except `/` including empty string.
2019-09-20 11:26:00 +00:00
- `?` — Substitutes any single character.
- `{some_string,another_string,yet_another_one}` — Substitutes any of strings `'some_string', 'another_string', 'yet_another_one'` .
- `{N..M}` — Substitutes any number in range from N to M including both borders.
Constructions with `{}` are similar to the [remote table function ](../../query_language/table_functions/remote.md )).
**Example**
1. Suppose we have several files with the following relative paths:
- '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'
2. Query the amount of rows in these files:
```sql
SELECT count(*)
FROM file('{some,another}_dir/some_file_{1..3}', 'TSV', 'name String, value UInt32')
```
3. Query the amount of rows in all files of these two directories:
```sql
SELECT count(*)
FROM file('{some,another}_dir/*', 'TSV', 'name String, value UInt32')
```
2019-09-04 11:11:30 +00:00
!!! warning
If your listing of files contains number ranges with leading zeros, use the construction with braces for each digit separately or use `?` .
2019-09-20 11:26:00 +00:00
**Example**
Query the data from files named `file000` , `file001` , ... , `file999` :
```sql
SELECT count(*)
FROM file('big_dir/file{0..9}{0..9}{0..9}', 'CSV', 'name String, value UInt32')
```
2019-09-04 11:11:30 +00:00
2020-01-15 07:52:45 +00:00
## Virtual Columns
- `_path` — Path to the file.
- `_file` — Name of the file.
**See Also**
- [Virtual columns ](https://clickhouse.yandex/docs/en/operations/table_engines/#table_engines-virtual_columns )
2018-10-16 10:47:17 +00:00
[Original article ](https://clickhouse.yandex/docs/en/query_language/table_functions/file/ ) <!--hide-->