rivet-cli 0.7.7

Rivet: PostgreSQL/MySQL → Parquet/CSV (local, S3, GCS). Crate name rivet-cli; binary rivet.
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

# S3 Destination (AWS S3 / MinIO / R2)

## Config block

```yaml
destination:
  type: s3
  bucket: my-data-bucket            # S3 bucket name (must already exist)
  prefix: exports/daily/            # optional key prefix (folder-like path)
  region: us-east-1                 # AWS region (required for AWS S3)
```

## Credentials

Rivet uses [OpenDAL](https://opendal.apache.org/) for S3 access. Credentials are resolved in this order:

### Option 1: AWS default credential chain (recommended)

If you're running on EC2, ECS, Lambda, or have `~/.aws/credentials` configured, just set `region`:

```yaml
destination:
  type: s3
  bucket: my-data-bucket
  region: us-east-1
```

### Option 2: Environment variables

Set `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` before running:

```bash
export AWS_ACCESS_KEY_ID=AKIA...
export AWS_SECRET_ACCESS_KEY=wJa...
rivet run --config export.yaml
```

Or reference them in the config:

```yaml
destination:
  type: s3
  bucket: my-data-bucket
  region: us-east-1
  access_key_env: AWS_ACCESS_KEY_ID
  secret_key_env: AWS_SECRET_ACCESS_KEY
```

### Option 3: AWS profile

```yaml
destination:
  type: s3
  bucket: my-data-bucket
  region: us-east-1
  aws_profile: my-profile           # uses [my-profile] from ~/.aws/credentials
```

## S3-compatible endpoints (MinIO, R2, Wasabi)

For non-AWS S3-compatible services, add `endpoint`:

```yaml
# MinIO
destination:
  type: s3
  bucket: rivet-exports
  endpoint: "http://localhost:9000"
  region: us-east-1                 # required but can be any value
  access_key_env: MINIO_ACCESS_KEY
  secret_key_env: MINIO_SECRET_KEY

# Cloudflare R2
destination:
  type: s3
  bucket: my-r2-bucket
  endpoint: "https://ACCOUNT_ID.r2.cloudflarestorage.com"
  region: auto
  access_key_env: R2_ACCESS_KEY
  secret_key_env: R2_SECRET_KEY
```

## Anonymous access

For public or pre-configured buckets (e.g. MinIO in dev):

```yaml
destination:
  type: s3
  bucket: public-bucket
  endpoint: "http://localhost:9000"
  region: us-east-1
  allow_anonymous: true
```

## Output keys

Files are uploaded as:

```
s3://{bucket}/{prefix}{export_name}_{YYYYMMDD}_{HHMMSS}.{format}
```

Example: `s3://my-data-bucket/exports/daily/orders_20260406_120000.parquet`

## Streaming upload

Rivet streams data directly to S3 without buffering the entire file in memory. Peak RSS stays proportional to `batch_size`, not to the total export size.

## Verify

```bash
rivet doctor --config export.yaml
```

Output:

```
[OK] Destination 's3://my-data-bucket/exports/daily/' — bucket accessible, write test passed
```

## Troubleshooting

**`NoSuchBucket`** -- The bucket must already exist. Create it first: `aws s3 mb s3://my-data-bucket`.

**`AccessDenied`** -- Check IAM policy. Rivet needs `s3:PutObject` and `s3:GetBucketLocation`.

**`SignatureDoesNotMatch` with MinIO** -- Ensure `region` is set (even for MinIO, e.g. `us-east-1`).