ClickHouse/docs/en/sql-reference/table-functions/s3Cluster.md

slug	sidebar_position	sidebar_label	title
/en/sql-reference/table-functions/s3Cluster	181	s3Cluster	s3Cluster Table Function

Allows processing files from Amazon S3 and Google Cloud Storage Google Cloud Storage in parallel from many nodes in a specified cluster. On initiator it creates a connection to all nodes in the cluster, discloses asterisks in S3 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

s3Cluster(cluster_name, source, [,access_key_id, secret_access_key, [session_token]] [,format] [,structure])

Arguments

• cluster_name — Name of a cluster that is used to build a set of addresses and connection parameters to remote and local servers.
• source — URL 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.
• access_key_id, secret_access_key — Keys that specify credentials to use with given endpoint. Optional.
• session_token - Session token to use with the given keys. Optional when passing keys.
• format — The format of the file.
• structure — Structure of the table. Format 'column1_name column1_type, column2_name column2_type, ...'.

Returned value

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

Examples

Select the data from all the files in the /root/data/clickhouse and /root/data/database/ folders, using all the nodes in the cluster_simple cluster:

SELECT * FROM s3Cluster(
    'cluster_simple',
    'http://minio1:9001/root/data/{clickhouse,database}/*',
    'minio',
    'minio123',
    'CSV',
    'name String, value UInt32, polygon Array(Array(Tuple(Float64, Float64)))'
) ORDER BY (name, value, polygon);

Count the total amount of rows in all files in the cluster cluster_simple:

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

See Also

• S3 engine
• s3 table function