Skip to content

Commit 3f66d28

Browse files
committed
docs(duckdb): add S3-compatible endpoint secret example
Signed-off-by: Gonzalo Peña-Castellanos <goanpeca@gmail.com>
1 parent e4b4867 commit 3f66d28

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

docs/integrations/engines/duckdb.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -344,6 +344,31 @@ Using a dictionary allows you to assign custom names to your secrets for better
344344
)
345345
```
346346

347+
##### S3-Compatible Endpoint Example
348+
349+
An `s3` secret targets Amazon S3 by default. To use another S3-compatible object store (for example Backblaze B2, Cloudflare R2, or MinIO), set `endpoint` to the provider's S3 host:
350+
351+
=== "YAML"
352+
353+
```yaml linenums="1"
354+
gateways:
355+
duckdb:
356+
connection:
357+
type: duckdb
358+
catalogs:
359+
local: local.db
360+
remote: "s3://bucket/data/remote.duckdb"
361+
extensions:
362+
- name: httpfs
363+
secrets:
364+
- type: s3
365+
endpoint: "s3.example-region.example.com"
366+
region: "YOUR_REGION"
367+
key_id: "YOUR_ACCESS_KEY_ID"
368+
secret: "YOUR_SECRET_ACCESS_KEY"
369+
# url_style: path # For providers that require path-style addressing
370+
```
371+
347372
After configuring the secrets, you can directly reference S3 paths in your catalogs or in SQL queries without additional authentication steps.
348373

349374
Refer to the official DuckDB documentation for the full list of [supported S3 secret parameters](https://duckdb.org/docs/stable/extensions/httpfs/s3api.html#overview-of-s3-secret-parameters) and for more information on the [Secrets Manager configuration](https://duckdb.org/docs/configuration/secrets_manager.html).

0 commit comments

Comments
 (0)