File Table Engine
The File table engine keeps the data in a file in one of the supported file formats (
- Data export from ClickHouse to file.
- Convert data from one format to another.
- Updating data in ClickHouse via editing a file on a disk.
Usage in ClickHouse Server
Format parameter specifies one of the available file formats. To perform
SELECT queries, the format must be supported for input, and to perform
INSERT queries – for output. The available formats are listed in the
ClickHouse does not allow specifying filesystem path for
File. It will use folder defined by path setting in server configuration.
When creating table using
File(Format) it creates empty subdirectory in that folder. When data is written to that table, it’s put into
data.Format file in that subdirectory.
You may manually create this subfolder and file in server filesystem and then ATTACH it to table information with matching name, so you can query data from that file.
Be careful with this functionality, because ClickHouse does not keep track of external changes to such files. The result of simultaneous writes via ClickHouse and outside of ClickHouse is undefined.
1. Set up the
CREATE TABLE file_engine_table (name String, value UInt32) ENGINE=File(TabSeparated)
By default ClickHouse will create folder
2. Manually create
$ cat data.TabSeparated
3. Query the data:
SELECT * FROM file_engine_table
│ one │ 1 │
│ two │ 2 │
Usage in ClickHouse-local
In clickhouse-local File engine accepts file path in addition to
Format. Default input/output streams can be specified using numeric or human-readable names like
stdout. It is possible to read and write compressed files based on an additional engine parameter or file extension (
$ echo -e "1,2\n3,4" | clickhouse-local -q "CREATE TABLE table (a Int64, b Int64) ENGINE = File(CSV, stdin); SELECT a, b FROM table; DROP TABLE table"
Details of Implementation
SELECTqueries can be performed concurrently, but
INSERTqueries will wait each other.
- Supported creating new file by
- If file exists,
INSERTwould append new values in it.
- Not supported:
SELECT ... SAMPLE
PARTITION BY — Optional. It is possible to create separate files by partitioning the data on a partition key. In most cases, you don't need a partition key, and if it is needed you generally don't need a partition key more granular than by month. Partitioning does not speed up queries (in contrast to the ORDER BY expression). You should never use too granular partitioning. Don't partition your data by client identifiers or names (instead, make client identifier or name the first column in the ORDER BY expression).
For partitioning by month, use the
toYYYYMM(date_column) expression, where
date_column is a column with a date of the type Date. The partition names here have the
_path— Path to the file. Type:
_file— Name of the file. Type:
_size— Size of the file in bytes. Type:
Nullable(UInt64). If the size is unknown, the value is
- engine_file_empty_if_not_exists - allows to select empty data from a file that doesn't exist. Disabled by default.
- engine_file_truncate_on_insert - allows to truncate file before insert into it. Disabled by default.
- engine_file_allow_create_multiple_files - allows to create a new file on each insert if format has suffix. Disabled by default.
- engine_file_skip_empty_files - allows to skip empty files while reading. Disabled by default.
- storage_file_read_method - method of reading data from storage file, one of:
mmap. The mmap method does not apply to clickhouse-server (it's intended for clickhouse-local). Default value: