Skip to content
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.

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

DuckDB data connector documentation #198

Merged
merged 4 commits into from
Apr 15, 2024
Merged
Changes from 1 commit
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
39 changes: 39 additions & 0 deletions spiceaidocs/docs/data-connectors/duckdb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: "DuckDB Data Connector"
sidebar_label: "DuckDB Data Connector"
description: "DuckDB Data Connector Documentation"
---

## Dataset Source

To connect to any DuckDB database as a data source, specify `duckdb` as the selector in the `from` value for the dataset.

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

## Configuration

The DuckDB data connector can be configured by providing the following `params`:

- `open`: The name for the file to back the DuckDB database. `open` is a required parameter, and DuckDB run in the `file` mode to open the DuckDB database file.

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

```yaml
datasets:
- from: duckdb:path.to.my_dataset
name: my_dataset
params:
open: path/to/my_database.duckdb
```

```yaml
Sevenannn marked this conversation as resolved.
Show resolved Hide resolved
datasets:
- from: duckdb:path.to.my_dataset
name: my_dataset
params:
open: path/to/my_database.db
```