S3 Datastore
Store data in an Amazon S3 bucket with local cache synchronization. Provides distributed locking via S3 conditional writes and bidirectional sync between a local cache directory and S3. Emits OpenTelemetry spans for S3 operations, lock acquisition/release, and push/pull sync so datastore activity is visible in traces when a TracerProvider is configured. Features shard-first indexing with per-model/per-workflow partition shards under _index/ as the source of truth (v2 repos skip the monolithic index upload entirely), commitSeq-based zero-diff fast path, two-phase sync to narrow the global-lock critical section, SHA-256 content hashing, per-path dirty tracking, namespace-scoped sync for multi-repo shared datastores, configurable transfer concurrency, and configurable per-request timeout.
Authentication
Uses the default AWS credential chain — no credentials in config. Provide credentials via one of:
- Environment variables:
AWS_ACCESS_KEY_ID,AWS_SECRET_ACCESS_KEY - AWS profile:
~/.aws/credentials - IAM role attached to the instance or task
Required IAM Permissions
s3:HeadBuckets3:GetObjects3:PutObjects3:DeleteObjects3:ListBuckets3:HeadObject
Usage
swamp datastore setup @swamp/s3-datastore \
--config '{"bucket": "my-bucket", "prefix": "swamp", "region": "us-east-1"}' --jsonS3-Compatible Endpoints
Supports S3-compatible services (MinIO, DigitalOcean Spaces, etc.) via the
endpoint and forcePathStyle config options.
Store data in an Amazon S3 bucket with local cache synchronization.
Config Fields
| Field | Type | Description |
|---|---|---|
| bucket | string | S3 bucket name |
| prefix? | string | Key prefix within the bucket |
| region? | string | AWS region (defaults to environment/credentials) |
| endpoint? | string | Custom S3-compatible endpoint URL (e.g., https://nyc3.digitaloceanspaces.com) |
| forcePathStyle? | boolean | Use path-style addressing (bucket in path, not subdomain). Default: false |
| pullConcurrency? | number | Maximum concurrent S3 downloads during pull. Default: 50 |
| pushConcurrency? | number | Maximum concurrent S3 uploads during push. Default: 25 |
| requestTimeoutMs? | number | Per-request timeout in milliseconds. Default: 30000. |
Modified 1 datastores
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned