Readyset caches
Deploy Readyset, add pull-based caches (shallow) for specific queries, and benchmark upstream vs cache head-to-head.
Use rdst cache deploy for an application-facing Readyset deployment.
For a local benchmark, rdst query cache-compare prepares a temporary sandbox;
it doesn't require deployment first.
The RDST cache workflow
- Deploy Readyset for a source database.
- Add queries using the registered cache target.
- Point your application at the Readyset endpoint when you're ready to use it.
rdst cache deploy --target prod-orders --mode docker
rdst cache add a1b2c3d4e5f6 --target prod-orders-cacheTo evaluate a query using the temporary sandbox:
rdst query cache-compare a1b2c3d4e5f6 --target prod-ordersDeployment modes
rdst cache deploy supports three modes, each appropriate for a different
environment:
| Mode | Use when |
|---|---|
docker | Use a local or remote Readyset container |
systemd | You've a dedicated host for Readyset (EC2, bare metal, etc.) |
kubernetes | Your infrastructure runs on K8s and you want Readyset there too |
Combined with --host (for remote deployment via SSH) and --script-only
(generate the deploy script without running it), this gives you four real flows:
# Local Docker
rdst cache deploy --target prod-orders --mode docker
# Remote host via SSH
rdst cache deploy --target prod-orders --mode docker \
--host 10.0.1.50 --ssh-user ubuntu --ssh-key ~/.ssh/prod.pem
# Systemd service
rdst cache deploy --target prod-orders --mode systemd
# Kubernetes
rdst cache deploy --target prod-orders --mode kubernetes \
--namespace readyset --kubeconfig ~/.kube/config
# Generate the script without executing
rdst cache deploy --target prod-orders --mode docker --script-onlySee rdst cache deploy for the full reference.
Sections in this guide
rdst cache deploy
Deploy Readyset locally, remotely via SSH, or in Kubernetes.
Managing caches
Add, list, delete, and tear down caches on a deployed Readyset instance.
Benchmarking with cache-compare
Measure upstream vs cached performance head-to-head with real traffic.
See also
rdst audit: the audit report ranks Readyset cache candidates across your databaserdst analyze: per-query cache-fit evaluation- Readyset QueryPilot: fully-managed caching on top of Readyset, when you want auto-discovery and push-based caching (deep)