Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 31 additions & 0 deletions spiceaidocs/docs/data-accelerators/duckdb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: 'DuckDB Data Accelerator'
sidebar_label: 'DuckDB Data Accelerator'
description: 'DuckDB Data Accelerator Documentation'
---

To use DuckDB as Data Accelerator, specify `duckdb` as the `engine` for acceleration.

```yaml
datasets:
- from: spiceai:path.to.my_dataset
name: my_dataset
acceleration:
engine: duckdb
```

## Configuration
The DuckDB accelerator can be configured by providing the following `params`:
- `duckdb_file`: The name for the file to back the DuckDB database. If the file does not exist, it will be created. Only applies if `mode` is `file`.

Configuration `params` are provided in the `acceleration` section for a data store. Other common `acceleration` fields can be configured for DuckDB, see see [datasets](../reference/spicepod/datasets.md).

```yaml
datasets:
- from: spiceai:path.to.my_dataset
name: my_dataset
acceleration:
engine: duckdb
params:
duckdb_file: /my/chosen/location/duckdb.db
```
2 changes: 1 addition & 1 deletion spiceaidocs/docs/data-accelerators/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ Currently supported Data Accelerators include:
| Engine Name | Description | Status | Engine Modes |
| --------------------------------- | ----------------------- | ------ | ---------------- |
| `arrow` | In-Memory Arrow Records | Alpha | `memory` |
| `duckdb` | Embedded DuckDB | Alpha | `memory`, `file` |
| [`duckdb`](./duckdb.md) | Embedded DuckDB | Alpha | `memory`, `file` |
| [`sqlite`](./sqlite.md) | Embedded SQLite | Alpha | `memory`, `file` |
| [`postgres`](./postgres/index.md) | Attached PostgreSQL | Alpha | |
2 changes: 1 addition & 1 deletion spiceaidocs/docs/data-accelerators/postgres/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The connection to PostgreSQL can be configured by providing the following `param
- `pg_pass_key`: The secret key containing the password to connect with.
- `pg_pass`: The plain-text password to connect with, ignored if `pg_pass_key` is provided.

Configuration `params` are provided either in the top level `dataset` for a dataset source and federated SQL query, or in the `acceleration` section for a data store.
Configuration `params` are provided either in the `acceleration` section of a dataset.

```yaml
datasets:
Expand Down
4 changes: 2 additions & 2 deletions spiceaidocs/docs/data-accelerators/sqlite.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ datasets:
The connection to SQLite can be configured by providing the following `params`:
- `sqlite_file`: The filename for the file to back the SQLite database. Only applies if `mode` is `file`.

Configuration `params` are provided either in the `acceleration` section for a data store. Other common `acceleration` fields can be configured for sqllite, see see [datasets](../reference/spicepod/datasets.md).
Configuration `params` are provided in the `acceleration` section of a dataset. Other common `acceleration` fields can be configured for sqlite, see see [datasets](../reference/spicepod/datasets.md).

```yaml
datasets:
Expand All @@ -27,5 +27,5 @@ datasets:
acceleration:
engine: sqlite
params:
sqlite_file: /my/chosen/location/sqllite.db
sqlite_file: /my/chosen/location/sqlite.db
```