backup

type CaptureStats struct {
	Window                Window  `json:"window"`
	Bytes                 int64   `json:"bytes"`
	ThroughputBytesPerSec float64 `json:"throughput_bytes_per_sec"`
}

type CommandRunner func(ctx context.Context, env []string, name string, args ...string) ([]byte, error)

type Deps struct {
	Repo        *Repository
	WALG        *WALG
	Tenants     TenantLister
	Objects     ObjectStoreOpener
	Streams     StreamStore
	StreamNames []string
	Lock        Locker
	MaxAge      MaxAge
	TempDir     string           // spool and snapshot files; "" = os.TempDir()
	Now         func() time.Time // nil = time.Now
	Rand        io.Reader        // point ID suffixes; nil = crypto/rand.Reader
	Tracer      trace.Tracer     // nil = telemetry.Instrumentation("pkg/backup")
	Meter       metric.Meter     // nil = telemetry.Instrumentation("pkg/backup")
}

type ListResult struct {
	Complete   []*Manifest // ascending by point ID (time)
	Incomplete []string
}

type Locker interface {
	TryAcquire(ctx context.Context) (release func(context.Context) error, err error)
}

type Manifest struct {
	SchemaVersion int             `json:"schema_version"`
	ID            string          `json:"id"`
	StartedAt     time.Time       `json:"started_at"`
	FinishedAt    time.Time       `json:"finished_at"`
	Postgres      PostgresCapture `json:"postgres"`
	Objects       ObjectsCapture  `json:"objects"`
	NATS          NATSCapture     `json:"nats"`
}

type MaxAge struct {
	Postgres, Objects, NATS time.Duration
}

type NATSCapture struct {
	Streams []StreamCapture `json:"streams"`
	CaptureStats
}

type ObjectEntry struct {
	Key    string `json:"key"`
	SHA256 string `json:"sha256"`
	Size   int64  `json:"size"`
}

type ObjectStoreOpener func(tenantID string) (storage.Provider, error)

type ObjectsCapture struct {
	Tenants map[string][]ObjectEntry `json:"tenants"`
	CaptureStats
}

type PointList struct {
	Complete   []string // manifest.json present
	Incomplete []string // IN_PROGRESS only: the run failed or is still going
}

type PointReport struct {
	ID               string
	Issues           []string      // integrity problems; empty means intact
	EstimatedRestore time.Duration // captured bytes / capture throughput; 0 when unknown
}

type PostgresCapture struct {
	BackupName string `json:"backup_name"`
	StartLSN   uint64 `json:"start_lsn"`
	FinishLSN  uint64 `json:"finish_lsn"`
	Timeline   uint32 `json:"timeline"`
	CaptureStats
}

type Repository struct {
	// contains filtered or unexported fields
}

type SQLTenantLister struct {
	// contains filtered or unexported fields
}

type Service struct {
	// contains filtered or unexported fields
}

type StoreAge struct {
	Store       string
	NewestPoint string // "" when no valid point exists
	Age         time.Duration
	MaxAge      time.Duration
	Stale       bool
}

type StreamCapture struct {
	Stream string       `json:"stream"`
	Files  []StreamFile `json:"files"`
	State  StreamState  `json:"state"`
}

type StreamFile struct {
	Name   string `json:"name"`
	SHA256 string `json:"sha256"`
	Size   int64  `json:"size"`
}

type StreamState struct {
	FirstSeq uint64 `json:"first_seq"`
	LastSeq  uint64 `json:"last_seq"`
	Msgs     uint64 `json:"msgs"`
}

type StreamStore interface {
	// Exists reports whether stream exists on the server.
	Exists(ctx context.Context, stream string) (bool, error)
	// Snapshot writes a snapshot of stream into the empty directory dir and
	// returns the state the snapshot holds.
	Snapshot(ctx context.Context, stream, dir string) (StreamState, error)
	// Restore recreates stream from the snapshot files in dir and returns the
	// stream's state afterwards.
	Restore(ctx context.Context, stream, dir string) (StreamState, error)
}

type TenantLister interface {
	TenantIDs(ctx context.Context) ([]string, error)
}

type VerifyOptions struct {
	PointID string
}

type VerifyReport struct {
	Points     []PointReport
	Incomplete []string
	WAL        []WALCheck
	Staleness  []StoreAge
}

type WALCheck struct {
	Name   string
	Status string
}

type WALG struct {
	// contains filtered or unexported fields
}

type WALGBackup struct {
	Name           string    `json:"backup_name"`
	WALFileName    string    `json:"wal_file_name"`
	StartTime      time.Time `json:"start_time"`
	FinishTime     time.Time `json:"finish_time"`
	StartLSN       uint64    `json:"start_lsn"`
	FinishLSN      uint64    `json:"finish_lsn"`
	CompressedSize int64     `json:"compressed_size"`
}

type Window struct {
	Start time.Time `json:"start"`
	End   time.Time `json:"end"`
}