Expand description
Runtime configuration loaded from datasets.toml.
Each instance binds to a list of datasets. A dataset’s [dataset.source]
block selects the format (parquet or delta) and the location (a
local path or an s3://bucket/key URL). When the location is on S3,
an optional [dataset.s3] block carries non-secret connection details
(region, endpoint, addressing style, …).
Credentials are resolved at runtime via DatasetConfig::resolved_creds
in this precedence order:
- Per-dataset env vars
${PREFIX}_AWS_ACCESS_KEY_ID,${PREFIX}_AWS_SECRET_ACCESS_KEY,${PREFIX}_AWS_SESSION_TOKENwhere${PREFIX}is the dataset name uppercased with non-alphanumeric characters replaced by_(e.g.accidents→ACCIDENTS,sales.eu-1→SALES_EU_1). - Inline
access_key_id/secret_access_key/session_tokenin the[dataset.s3]block. - Plain
AWS_ACCESS_KEY_ID/AWS_SECRET_ACCESS_KEY/AWS_SESSION_TOKEN. - None — fall back to the engine’s own provider chain
(
~/.aws/credentials, IMDS, …).
Structs§
- AppConfig
- Auth
Config - OIDC bearer-token enforcement for the HTTP API (
[auth]block). - Data
Fusion Config - DataFusion backend performance tuning (
[datafusion]block). - Dataset
Config - Docs
Config - Embedded MkDocs documentation site (
[docs]block). - Explorer
Config - Embedded dataset explorer UI (
[explorer]block). - Index
Config - Metrics
Config - Prometheus metrics endpoint (
[metrics]block). - Quack
Config - Experimental DuckDB Quack remote protocol server.
- Resolved
Creds - Resolved S3 credentials.
Nonefields mean “let the engine’s default provider chain figure it out”. - S3Config
- Non-secret S3 connection settings. Credentials are pulled from env / the
AWS credential chain — see
DatasetConfig::resolved_creds. - Server
Config - Source
Config - SqlConfig
- Raw-SQL query endpoint (
[sql]block). - Swagger
Config - Swagger UI + embedded OpenAPI spec (
[swagger]block). - SwaggerO
Auth2 Config - OIDC single-sign-on for the Swagger UI (
[swagger.oauth2]).
Enums§
- Addressing
Style - Backend
- Bucket
InHost - Whether the bucket name is folded into the endpoint hostname for
virtual-hosted-style requests against a custom endpoint. This aligns the
DataFusion object-store path with DuckDB, which builds the virtual host
itself — so the same plain
endpointworks on both backends. - Index
Mode - Partitioning
- How hive-style partition columns (
key=value/path segments) are handled for an S3 parquet source. Local parquet always auto-detects; this option brings S3 in line and lets you force or disable the behaviour. - Source
Kind