rivet-cli 0.2.0-beta.2

CLI tool to export PostgreSQL and MySQL to Parquet/CSV (local, S3, GCS) with tuning, preflight checks, and SQLite-backed state.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

# Rivet Documentation

Rivet exports data from PostgreSQL and MySQL to Parquet/CSV files on local disk, S3, or GCS.

This folder contains modular guides for running your first pilot exports and a complete configuration reference.

## Start Here

| Guide | Description |
|-------|-------------|
| [Getting Started](getting-started.md) | Install Rivet, connect to your database, run your first export |
| [Quickstart: Postgres](pilot/quickstart-postgres.md) | End-to-end pilot in 5 minutes (PostgreSQL) |
| [Quickstart: MySQL](pilot/quickstart-mysql.md) | End-to-end pilot in 5 minutes (MySQL) |

## Export Modes

| Mode | When to Use | Guide |
|------|-------------|-------|
| **full** | Snapshot the entire result set each run | [modes/full.md](modes/full.md) |
| **incremental** | Only export rows newer than the last cursor | [modes/incremental.md](modes/incremental.md) |
| **chunked** | Split large tables into parallel ranges by ID | [modes/chunked.md](modes/chunked.md) |
| **time_window** | Export a rolling N-day window | [modes/time-window.md](modes/time-window.md) |

## Destinations

| Destination | Guide |
|-------------|-------|
| Local filesystem | [destinations/local.md](destinations/local.md) |
| AWS S3 / MinIO / R2 | [destinations/s3.md](destinations/s3.md) |
| Google Cloud Storage | [destinations/gcs.md](destinations/gcs.md) |
| Stdout (pipe) | [destinations/stdout.md](destinations/stdout.md) |

## Reference

| Topic | Guide |
|-------|-------|
| Complete YAML config reference | [reference/config.md](reference/config.md) |
| Tuning profiles and parameters | [reference/tuning.md](reference/tuning.md) |
| CLI commands and flags | [reference/cli.md](reference/cli.md) |

## Production

| Topic | Guide |
|-------|-------|
| Production checklist | [pilot/production-checklist.md](pilot/production-checklist.md) |

## Example Configs

Ready-to-use YAML templates live in the [`examples/`](../examples/) directory.

## Deep Reference

For the full 25-section reference manual, see [USER_GUIDE.md](../USER_GUIDE.md).