Skip to content

Commit 476efd0

Browse files
authored
add extra_credentials to s3Cluster
1 parent f17dd06 commit 476efd0

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Allows processing files from [Amazon S3](https://aws.amazon.com/s3/) and Google
1717
**Syntax**
1818

1919
```sql
20-
s3Cluster(cluster_name, url [, NOSIGN | access_key_id, secret_access_key, [session_token]] [,format] [,structure] [,compression_method],[,headers])
20+
s3Cluster(cluster_name, url[, NOSIGN | access_key_id, secret_access_key,[session_token]][, format][, structure][, compression_method][, headers][, extra_credentials])
2121
s3Cluster(cluster_name, named_collection[, option=value [,..]])
2222
```
2323

@@ -31,7 +31,8 @@ s3Cluster(cluster_name, named_collection[, option=value [,..]])
3131
- `format` — The [format](/sql-reference/formats) of the file.
3232
- `structure` — Structure of the table. Format `'column1_name column1_type, column2_name column2_type, ...'`.
3333
- `compression_method` — Parameter is optional. Supported values: `none`, `gzip` or `gz`, `brotli` or `br`, `xz` or `LZMA`, `zstd` or `zst`. By default, it will autodetect compression method by file extension.
34-
- `headers` - Parameter is optional. Allows headers to be passed in the S3 request. Pass in the format `headers(key=value)` e.g. `headers('x-amz-request-payer' = 'requester')`. See [here](/sql-reference/table-functions/s3#accessing-requester-pays-buckets) for example of use.
34+
- `headers` - Optional. Allows headers to be passed in the S3 request. Pass in the format `headers(key=value)` e.g. `headers('x-amz-request-payer' = 'requester')`. See [here](/sql-reference/table-functions/s3#accessing-requester-pays-buckets) for an example.
35+
- `extra_credentials` - Optional. `roleARN` can be passed via this parameter. See [here](/cloud/security/secure-s3#access-your-s3-bucket-with-the-clickhouseaccess-role) for an example.
3536

3637
Arguments can also be passed using [named collections](operations/named-collections.md). In this case `url`, `access_key_id`, `secret_access_key`, `format`, `structure`, `compression_method` work in the same way, and some extra parameters are supported:
3738

0 commit comments

Comments
 (0)