Guides

On this page

Step-by-step guides. Each guide walks through a specific task.

Create a Lib Function

How to build a lib function for API ingestion or outbound sync. Step-by-step from API dict to working fetch/push function.

Set Up OAuth Authentication

How to authenticate with OAuth providers for API ingestion and outbound sync. One-time setup, automatic token refresh.

Fetch Data from APIs

Pull data from REST APIs into your pipeline using lib functions. Pagination, incremental loads, OAuth, and error handling.

Collect Events

Collect events via HTTP POST with durable buffering. Events are materialized into DuckLake during pipeline runs.

Serve Data via OData

Serve pipeline results to Power BI, Excel, Grafana, or any OData-compatible BI tool via OData v4.

Preview Changes

Preview all pipeline changes before committing to production. OndatraSQL's sandbox mode runs against a temporary catalog copy.

Sync Data to External APIs

Push pipeline data to external APIs using @sink. Step-by-step setup with batching, rate limiting, and per-row tracking.

Maintain DuckLake Storage

Compact files, expire snapshots, and clean up storage in DuckLake.

Schedule Pipeline Runs

Install an OS-native scheduler for automated pipeline runs. One command sets up systemd on Linux or launchd on macOS.

Mask Sensitive Columns

Apply mask, hash, or redact tags to columns and the pipeline handles the rest. Protect sensitive data during materialization.