ContextQMD
Back to Clickhouse

hdfsCluster

docs/en/sql-reference/table-functions/hdfsCluster.md

26.4.1.1-new3.5 KB
Original Source

hdfsCluster Table Function

Allows processing files from HDFS in parallel from many nodes in a specified cluster. On initiator it creates a connection to all nodes in the cluster, discloses asterisks in HDFS file path, and dispatches each file dynamically. On the worker node it asks the initiator about the next task to process and processes it. This is repeated until all tasks are finished.

Syntax {#syntax}

sql
hdfsCluster(cluster_name, URI, format, structure)

Arguments {#arguments}

ArgumentDescription
cluster_nameName of a cluster that is used to build a set of addresses and connection parameters to remote and local servers.
URIURI to a file or a bunch of files. Supports following wildcards in readonly mode: *, **, ?, {'abc','def'} and {N..M} where N, M — numbers, abc, def — strings. For more information see Wildcards In Path.
formatThe format of the file.
structureStructure of the table. Format 'column1_name column1_type, column2_name column2_type, ...'.

Returned value {#returned_value}

A table with the specified structure for reading data in the specified file.

Examples {#examples}

  1. Suppose that we have a ClickHouse cluster named cluster_simple, and several files with 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'
  1. Query the amount of rows in these files:
sql
SELECT count(*)
FROM hdfsCluster('cluster_simple', 'hdfs://hdfs1:9000/{some,another}_dir/some_file_{1..3}', 'TSV', 'name String, value UInt32')
  1. Query the amount of rows in all files of these two directories:
sql
SELECT count(*)
FROM hdfsCluster('cluster_simple', 'hdfs://hdfs1:9000/{some,another}_dir/*', 'TSV', 'name String, value UInt32')

:::note If your listing of files contains number ranges with leading zeros, use the construction with braces for each digit separately or use ?. :::

Related {#related}