Expand description
sleet is a fleet manager for SlateDB
databases: it runs their background services (garbage collection,
compaction coordination, and compaction execution) outside the
writer process. See rfcs/ for the design.
Use Fleet for the supported programmatic API. It opens object
stores from URLs using credentials and provider settings in the
process environment. The caller owns the Tokio runtime, tracing
subscriber, and cancellation signal.
Structs§
- Cancellation
Token - A token which can be used to signal a cancellation request to one or more tasks.
- Database
Status - One registered database and its service placement.
- Fleet
- A fleet root opened with object-store settings from the process environment.
- Human
Duration - A duration in humantime form, e.g.
"10s","5m","1h 30m". - Mirror
Restore Response - The
sleet mirror restoreresponse. - Mirror
Status - One
(database, target)mirror’s lag, from the source and destination heads. - Mirror
Sync Options - Node-local options for a one-shot mirror sync.
- Mirror
Sync Response - The
sleet mirror syncresponse: one pass, plus the prune that follows it when retention is set. - Node
Options - Node-specific settings, from flags only; everything else lives in the fleet root.
- Node
Status - One fleet member.
- Queue
Status - Compaction queue depth for one database.
- Register
Response - The
sleet registerresponse. - Service
Placement - Where one database service runs: the top of the service’s rendezvous
ranking. One node for
gcandcompactor-coordinator, the topcountnodes forcompaction-workers. Empty means no live node offers the service. - Status
Options - Optional, more expensive status probes.
- Status
Response - The
sleet statusresponse, derived from the fleet root: node liveness, roles, and versions fromnodes/, registered databases fromdbs/, and placement by computing the same rendezvous ranking the nodes do.
Enums§
- Error
- A supported API operation failure.
- Restore
Point - Which restore point to restore.
- Service
- A per-database service.
Constants§
- SLATEDB_
VERSION - The slatedb version compiled into this binary (from Cargo.lock via build.rs), carried in heartbeat bodies.
Functions§
- mirror_
restore - Restore a backup URL into an empty destination URL.