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

Add localpod docs #565

Merged
merged 6 commits into from
Oct 31, 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/components/data-connectors/localpod.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: 'Localpod Data Connector'
sidebar_label: 'Localpod Data Connector'
description: 'Localpod Data Connector Documentation'
pagination_prev: null
---

The Localpod Data Connector enables setting up a parent/child relationship between datasets in the current Spicepod. This is useful for configuring multiple/tiered accelerations for a single dataset, and ensuring that the data is only downloaded once from the remote source.
phillipleblanc marked this conversation as resolved.
Show resolved Hide resolved

The dataset created by the `localpod` connector will logically have the same data as the parent dataset.

## Synchronized Refreshes

The `localpod` connector supports synchronized refreshes, which ensures that the child dataset is refreshed from the same data as the parent dataset. Synchronized refreshes require that both the parent and child datasets are accelerated with `refresh_mode: full` (which is the default).

When synchronization is enabled, the following logs will be emitted:

```bash
2024-10-28T15:45:24.220665Z INFO runtime::datafusion: Localpod dataset test_local synchronizing refreshes with parent table test
```

### Examples

```yaml
datasets:
- from: postgres:cleaned_sales_data
name: test
params:
...
acceleration:
enabled: true # This dataset will be accelerated into a DuckDB file
engine: duckdb
mode: file
refresh_check_interval: 10s
- from: localpod:test
name: test_local
acceleration:
enabled: true # This dataset accelerates the parent `test` dataset into in-memory Arrow records and is synchronized with the parent
```