Skip to content

docs: add non-AWS endpoint guidance and list Tigris as compatible #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adsharma merged 2 commits into from
Apr 16, 2026
Merged

docs: add non-AWS endpoint guidance and list Tigris as compatible #23

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13ebd6e
Update s3.mdx
davidmyriel Apr 15, 2026
6f3ea97
Potential fix for pull request finding
davidmyriel Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion src/content/docs/extensions/s3.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,22 @@ You can alternatively set the following environment variables:
| `S3_REGION` | S3 region |
| `S3_URL_STYLE` | S3 URL style |

### Using a non-AWS endpoint
Comment thread
adsharma marked this conversation as resolved.

To connect to an S3-compatible service (such as Cloudflare R2, MinIO, or Tigris), set `s3_endpoint` to the service's endpoint and provide credentials as usual:

```cypher
CALL s3_access_key_id='<your-key-id>';
CALL s3_secret_access_key='<your-secret>';
CALL s3_endpoint='<service-endpoint>';
CALL s3_region='auto';
```

A few notes:

- `s3_region` is required for request signing but is ignored by most non-AWS services. Any non-empty value works; `auto` is a common convention.
- `s3_url_style` defaults to `vhost` (virtual-hosted-style). Some services (for example, MinIO in its default configuration) require path-style URLs — set `s3_url_style='path'` in that case.

### Scanning data from S3

The example below shows how to scan data from a Parquet file hosted on S3.
Expand Down Expand Up @@ -91,7 +107,7 @@ TO 's3://lbug-datasets/saved/location.parquet';
#### Requirements on the S3 server APIs

S3 offers a standard set of APIs for read and write operations. The `httpfs` extension uses these APIs to communicate with remote storage services and thus should also work
with other services that are compatible with the S3 API (such as [Cloudflare R2](https://www.cloudflare.com/en-gb/developer-platform/r2/)).
with other services that are compatible with the S3 API (such as [Cloudflare R2](https://www.cloudflare.com/en-gb/developer-platform/r2/) and [Tigris](https://www.tigrisdata.com/)).

The table below shows which parts of the S3 API are needed for each feature of the extension to work.

Expand Down
Loading