SubQuery Snapshot Toolkit

Open toolkit that automates SubQuery snapshot creation: schedule jobs, compress output, upload to storage, and verify restores with a single command.

Why operators use it

Indexers frequently need bespoke snapshots for DR drills, staging, or private customers. Instead of writing brittle bash scripts, the toolkit provides guardrails, logging, and reusable recipes inspired by our managed service.

Use it alongside the managed SubQuery Snapshot Service: rely on public artifacts when possible, spin up your own when you require total control.

Snapshot toolkit logo

Features

Automate the entire backup pipeline

Custom snapshot generation

Schedule PostgreSQL dumps or filesystem captures with compression, encryption, and retention tailored to your infrastructure.

Configurable & lightweight

Single CLI plus YAML config for database hosts, dumping strategy, resource throttling, and post-processing hooks.

Local & S3-compatible storage

Push artifacts to disk, NFS, or any S3 backend (AWS, GCS, MinIO) with checksum manifests for integrity checks.

Remote database support

Safely run backups from dedicated hosts without touching production indexers using SSH tunnels and connection profiles.

Observability hooks

Optional Slack/Telegram notifications, CI-friendly exit codes, and structured logs keep operators informed.

Toolkit contents

  • CLI wrapper orchestrating pg_dump/pg_basebackup with streaming compression.
  • Example systemd timers, GitHub Actions, and Terraform snippets for scheduling.
  • Checksum manifest generator to validate restores automatically.
  • Hook system for uploads, pruning, or notifications after dumps finish.
Snapshot toolkit CLI

Why teams adopt it

The toolkit reduces operational toil by standardizing how backups are triggered, monitored, and validated. New engineers learn a single CLI instead of deciphering unique scripts per server.

Extensibility means you can add new storage drivers or integrate with enterprise schedulers while keeping the workflow consistent.