backup

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

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

type Info struct {
	ID      string    `json:"id"`
	Kind    Kind      `json:"kind"`
	Target  string    `json:"target,omitempty"`
	State   State     `json:"state"`
	Step    string    `json:"step,omitempty"`
	Percent int       `json:"percent"`
	Error   string    `json:"error,omitempty"`
	Created time.Time `json:"created"`
	Size    int64     `json:"size,omitempty"`
	Parts   []string  `json:"parts,omitempty"`
	Plugins []string  `json:"plugins,omitempty"`
	// MediaMissing counts media files the database references that were not
	// on disk; the backup is still OK, it just lacks them.
	MediaMissing int `json:"media_missing,omitempty"`
}

type Kind string

type Options struct {
	Data        string // the data dir; backups live in $Data/backups
	MediaDir    string // upload dir of the content export; empty means ./uploads
	DatabaseURL string
	Pool        *pgxpool.Pool // nil means the database is not reachable
	Run         ExecFunc      // nil means OSExec
	// Free reports the bytes writable under dir; nil skips the space check.
	Free          func(dir string) (uint64, error)
	Now           func() time.Time
	Log           *slog.Logger
	Version       string // hatamoto version, recorded in the manifest
	KeepManual    int
	KeepPreUpdate int
	// SecretsDir holds secrets.env; the file is added to a backup when present.
	SecretsDir string
	// ConfigPath is the operator's env file, stored verbatim; its path is
	// recorded in the manifest as an absolute path. Empty means no
	// config part; a Request.ConfigPath wins.
	ConfigPath string
	// Trust gives the key IDs recorded in the manifest; nil means the IDs
	// embedded in this binary.
	Trust func() (TrustIDs, error)
}

type Plugin struct {
	Name   string // display name, e.g. foo-bar
	Schema string // plugin_foo_bar
	Role   string
}

type Querier interface {
	Query(ctx context.Context, sql string, args ...any) (pgx.Rows, error)
	QueryRow(ctx context.Context, sql string, args ...any) pgx.Row
}

type RefusalError struct{ Reasons []string }

type Request struct {
	Kind   Kind
	Target string        // the version a pre-update backup protects
	Wait   time.Duration // how long a pre-update backup waits for the lock; 0 means DefaultWait
	// ConfigPath overrides Options.ConfigPath for this backup.
	ConfigPath string
}

type RestoreOptions struct {
	Data        string // the data dir; an id source is $Data/backups/<id>.tar
	MediaDir    string // must be empty or missing
	SecretsDir  string // secrets.env is written here
	DatabaseURL string // the app role on the empty target database
	Version     string // the running hatamoto version; must equal the backup's
	Run         ExecFunc
	// Q reads the target database (emptiness, server major). Nil opens a pool
	// from DatabaseURL for the checks.
	Q           Querier
	ServerMajor func(ctx context.Context) (int, error)
	// Trust gives the key IDs of this binary; nil means the embedded ones.
	Trust    func() (TrustIDs, error)
	OpenPool func(ctx context.Context, url string) (*pgxpool.Pool, error)
	// OpenAdmin connects with the admin URL (pointed at the target database)
	// for the pre-flight checks; nil connects with pgx.
	OpenAdmin func(ctx context.Context, url string) (Querier, func(), error)
	Log       *slog.Logger
	// Getenv reads the ambient environment for the libpq overrides check; nil
	// means os.Getenv.
	Getenv func(string) string
}

type RestorePlan struct {
	Backup   string
	Checks   []string
	Would    []string
	Warnings []string
	DryRun   bool
	Done     bool // the steps ran: Print says "done", not "would"
}

type RestoreRequest struct {
	Source    string // a backup id or the path of a .tar
	AdminURL  string // superuser DSN for the role bootstrap
	ConfigOut string // where to write the recorded config; empty means the config is not written
	DryRun    bool
}

type State string

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

type TrustIDs struct {
	Release  []string `json:"release,omitempty"`
	Manifest []string `json:"manifest,omitempty"`
	Env      []string `json:"env,omitempty"`
}