2019-09-03 14:23:51 +00:00
# HDFS {#table_engines-hdfs}
2019-09-04 13:24:41 +00:00
This engine provides integration with [Apache Hadoop ](https://en.wikipedia.org/wiki/Apache_Hadoop ) ecosystem by allowing to manage data on [HDFS ](https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-hdfs/HdfsDesign.htmll )via ClickHouse. This engine is similar
2019-09-04 13:25:07 +00:00
to the [File ](file.md ) and [URL ](url.md ) engines, but provides Hadoop-specific features.
2019-09-03 14:23:51 +00:00
## Usage
2019-09-23 15:31:46 +00:00
```sql
2019-09-03 14:23:51 +00:00
ENGINE = HDFS(URI, format)
```
2019-09-04 19:55:56 +00:00
The `URI` parameter is the whole file URI in HDFS.
2019-09-03 14:23:51 +00:00
The `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
[Formats ](../../interfaces/formats.md#formats ) section.
2019-09-20 11:26:00 +00:00
The path part of `URI` may contain globs. In this case the table would be readonly.
2019-09-03 14:23:51 +00:00
**Example:**
2019-09-04 13:26:52 +00:00
**1.** Set up the `hdfs_engine_table` table:
2019-09-03 14:23:51 +00:00
2019-09-23 15:31:46 +00:00
```sql
2019-09-03 14:23:51 +00:00
CREATE TABLE hdfs_engine_table (name String, value UInt32) ENGINE=HDFS('hdfs://hdfs1:9000/other_storage', 'TSV')
```
2019-09-04 19:55:56 +00:00
**2.** Fill file:
2019-09-23 15:31:46 +00:00
```sql
2019-09-04 19:55:56 +00:00
INSERT INTO hdfs_engine_table VALUES ('one', 1), ('two', 2), ('three', 3)
```
**3.** Query the data:
2019-09-03 14:23:51 +00:00
2019-09-23 15:31:46 +00:00
```sql
2019-09-03 14:23:51 +00:00
SELECT * FROM hdfs_engine_table LIMIT 2
```
2019-09-23 15:31:46 +00:00
```text
2019-09-03 14:23:51 +00:00
┌─name─┬─value─┐
│ one │ 1 │
│ two │ 2 │
└──────┴───────┘
```
2019-09-04 13:26:03 +00:00
## Implementation Details
2019-09-03 14:23:51 +00:00
- Reads and writes can be parallel
- Not supported:
- `ALTER` and `SELECT...SAMPLE` operations.
- Indexes.
- Replication.
2019-09-20 11:26:00 +00:00
**Globs in path**
Multiple path components can have globs. For being processed file should exists and matches to the whole path pattern. Listing of files determines during `SELECT` (not at `CREATE` moment).
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 in TSV format with the following URIs on HDFS:
- 'hdfs://hdfs1:9000/some_dir/some_file_1'
- 'hdfs://hdfs1:9000/some_dir/some_file_2'
- 'hdfs://hdfs1:9000/some_dir/some_file_3'
- 'hdfs://hdfs1:9000/another_dir/some_file_1'
- 'hdfs://hdfs1:9000/another_dir/some_file_2'
- 'hdfs://hdfs1:9000/another_dir/some_file_3'
2. There are several ways to make a table consisting of all six files:
```sql
CREATE TABLE table_with_range (name String, value UInt32) ENGINE = HDFS('hdfs://hdfs1:9000/{some,another}_dir/some_file_{1..3}', 'TSV')
```
Another way:
```sql
CREATE TABLE table_with_question_mark (name String, value UInt32) ENGINE = HDFS('hdfs://hdfs1:9000/{some,another}_dir/some_file_?', 'TSV')
```
Table consists of all the files in both directories (all files should satisfy format and schema described in query):
```sql
CREATE TABLE table_with_asterisk (name String, value UInt32) ENGINE = HDFS('hdfs://hdfs1:9000/{some,another}_dir/*', 'TSV')
```
!!! warning
If the listing of files contains number ranges with leading zeros, use the construction with braces for each digit separately or use `?` .
**Example**
Create table with files named `file000` , `file001` , ... , `file999` :
```sql
CREARE TABLE big_table (name String, value UInt32) ENGINE = HDFS('hdfs://hdfs1:9000/big_dir/file{0..9}{0..9}{0..9}', 'CSV')
```
2019-09-03 14:23:51 +00:00
[Original article ](https://clickhouse.yandex/docs/en/operations/table_engines/hdfs/ ) <!--hide-->