Skip to content

Commit

Permalink
s3 parquet doc
Browse files Browse the repository at this point in the history
  • Loading branch information
y-f-u committed Mar 15, 2024
1 parent 8b1771a commit faa3739
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
10 changes: 10 additions & 0 deletions spiceaidocs/content/en/reference/Connectors/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
type: docs
title: "Connectors"
linkTitle: "Connectors"
description: ''
weight: 70
---

## Connectors

44 changes: 44 additions & 0 deletions spiceaidocs/content/en/reference/Connectors/s3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
type: docs
title: "S3 Parquet Dataset"
linkTitle: "S3 Parquet Dataset"
description: 'S3 Parquet Dataset YAML reference'
weight: 80
---

Parquet data in S3-compatible storage can be queried in mesh mode or accelerated locally.

# `dataset`

```yaml
- from: s3://s3-bucket-name/path/to/parquet/file.parquet
name: s3_file
auth: s3
params:
endpoint: https://your.minio.host
region: ""
acceleration:
enabled: true
refresh_mode: full
```
## `params`

- `endpoint`: Check `with_endpoint` in [object store](https://docs.rs/object_store/latest/object_store/aws/struct.AmazonS3Builder.html)
- `region`: Check `with_region` in [object store](https://docs.rs/object_store/latest/object_store/aws/struct.AmazonS3Builder.html)

## `acceleration`

Optional.

When `null`, query will run in mesh mode; parquet data will be read directly from the object store for each query.

Only `full` refresh mode is supported.

## `auth`

Check [Secrets]({{<ref "reference/Secrets">}}).

Required attribbutes:
- `key`
- `secret`

0 comments on commit faa3739

Please sign in to comment.