db

Oct 20, 2026

Changes in this version

+ const BindingClaim

+ const BindingGroup

+ const BindingUser

+ const MaxLabels

+ const OpExists

+ const OpIn

+ const OpNotExists

+ const OpNotIn

+ const StaleAfter

+ var ErrLastAdmin = errors.New("this is the last binding that grants rbac:manage on everything")

+ var Unscoped = Scope

+ func ValidateLabels(l Labels) error

type APIKey

+ Role string

+ Selector Selector

+ type AdminSession struct

+ CreatedAt time.Time

+ Email string

+ ExpiresAt time.Time

+ ID uuid.UUID

+ LastSeenAt time.Time

+ Name string

+ RevokedAt *time.Time

+ RevokedBy string

+ SourceIP string

+ Subject string

+ UserAgent string

type Agent

+ Labels Labels

+ type AuditEntry struct

+ Action string

+ Actor string

+ ActorKind string

+ At time.Time

+ Details json.RawMessage

+ ID int64

+ Labels Labels

+ ResourceID string

+ ResourceKind string

+ ResourceName string

+ SourceIP string

+ type AuditFilter struct

+ Action string

+ Actor string

+ From *time.Time

+ Limit int

+ ResourceKind string

+ To *time.Time

type BackupJob

+ Labels Labels

+ OneFileSystem bool

type BackupTarget

+ Labels Labels

+ TokenCheck *pbs.TokenCheck

type DB

+ func (d *DB) BindingsFor(ctx context.Context, email string, groups, claims []string) ([]*RoleBinding, error)

+ func (d *DB) BootstrapAdmin(ctx context.Context, email, role string) (bool, error)

+ func (d *DB) CreateAdminSession(ctx context.Context, s *AdminSession) error

+ func (d *DB) CreateBinding(ctx context.Context, b *RoleBinding) error

+ func (d *DB) CreateRole(ctx context.Context, r *Role) error

+ func (d *DB) DeleteBinding(ctx context.Context, id uuid.UUID) error

+ func (d *DB) DeleteRole(ctx context.Context, name string) error

+ func (d *DB) GetBinding(ctx context.Context, id uuid.UUID) (*RoleBinding, error)

+ func (d *DB) GetRole(ctx context.Context, name string) (*Role, error)

+ func (d *DB) ListActiveAdminSessions(ctx context.Context) ([]*AdminSession, error)

+ func (d *DB) ListAudit(ctx context.Context, f AuditFilter, scope Scope) ([]*AuditEntry, error)

+ func (d *DB) ListBindings(ctx context.Context) ([]*RoleBinding, error)

+ func (d *DB) ListRoles(ctx context.Context) ([]*Role, error)

+ func (d *DB) ListSeenSubjects(ctx context.Context) ([]*SeenSubject, error)

+ func (d *DB) PruneAudit(ctx context.Context, before time.Time, export func([]*AuditEntry) error) (int, error)

+ func (d *DB) RecordSignIn(ctx context.Context, email string, groups, claims []string) error

+ func (d *DB) RevokeAdminSession(ctx context.Context, id uuid.UUID, by string) (*AdminSession, error)

+ func (d *DB) RevokeUserAdminSessions(ctx context.Context, email, by string) (int, error)

+ func (d *DB) ScopedBindingsOfRole(ctx context.Context, role string) (int, error)

+ func (d *DB) SetAgentLabels(ctx context.Context, id uuid.UUID, labels Labels) error

+ func (d *DB) SetTargetTokenCheck(ctx context.Context, id uuid.UUID, check *pbs.TokenCheck) (string, error)

+ func (d *DB) SyncBuiltinRoles(ctx context.Context, roles map[string][]string, descriptions map[string]string) error

+ func (d *DB) TouchAdminSession(ctx context.Context, id string) (bool, error)

+ func (d *DB) UpdateRole(ctx context.Context, r *Role) error

+ func (d *DB) WriteAudit(ctx context.Context, e *AuditEntry) error

type EnrollmentToken

+ Labels Labels

type KeyRing

+ Labels Labels

+ type Labels map[string]string

+ func (l Labels) Contains(sel Labels) bool

+ func (l Labels) Equal(o Labels) bool

+ func (l Labels) JSON() string

+ func (l Labels) OrEmpty() Labels

+ func (l Labels) String() string

+ type Requirement struct

+ Key string

+ Op string

+ Values []string

+ func (r Requirement) Matches(l Labels) bool

+ func (r Requirement) String() string

+ type Role struct

+ Bindings int

+ Builtin bool

+ CreatedAt time.Time

+ Description string

+ Name string

+ Permissions []string

+ UpdatedAt time.Time

+ type RoleBinding struct

+ CreatedAt time.Time

+ CreatedBy string

+ ID uuid.UUID

+ Kind string

+ LastSeen *time.Time

+ Permissions []string

+ Role string

+ Selector Selector

+ Stale bool

+ Subject string

+ type Scope struct

+ All bool

+ Selectors []Selector

+ func (s Scope) Empty() bool

+ func (s Scope) Matches(l Labels) bool

+ func (s Scope) SQL(col string, args []any) (string, []any)

+ type SeenSubject struct

+ Kind string

+ LastSeen time.Time

+ Value string

+ type Selector []Requirement

+ func MustSelector(text string) Selector

+ func ParseSelector(text string) (Selector, error)

+ func SelectorFromLabels(l Labels) Selector

+ func (s *Selector) Scan(src any) error

+ func (s *Selector) UnmarshalJSON(b []byte) error

+ func (s Selector) Equal(o Selector) bool

+ func (s Selector) MarshalJSON() ([]byte, error)

+ func (s Selector) Matches(l Labels) bool

+ func (s Selector) Narrows(wider Selector) bool

+ func (s Selector) String() string

Oct 16, 2026

Changes in this version

+ var ErrInUse = errors.New("record is in use")

type BackupJob

+ BackupID string

+ func (j *BackupJob) EffectiveBackupID() string

type BackupTarget

+ KeyRingID *uuid.UUID

+ KeyRingName string

type DB

+ func (d *DB) CreateKeyRing(ctx context.Context, r *KeyRing) error

+ func (d *DB) DeleteKeyRing(ctx context.Context, id uuid.UUID) error

+ func (d *DB) GetKeyRing(ctx context.Context, id uuid.UUID) (*KeyRing, error)

+ func (d *DB) HasSealedSecrets(ctx context.Context) (bool, error)

+ func (d *DB) ListKeyRings(ctx context.Context) ([]*KeyRing, error)

+ func (d *DB) ListRingKeys(ctx context.Context, ringID uuid.UUID) ([]*TargetKey, error)

+ func (d *DB) SetRingActiveKey(ctx context.Context, ringID uuid.UUID, keyID *uuid.UUID) error

+ func (d *DB) UpdateKeyRing(ctx context.Context, id uuid.UUID, name, masterPublicKey string) error

+ type KeyRing struct

+ ActiveKeyID *uuid.UUID

+ CreatedAt time.Time

+ CreatedBy string

+ ID uuid.UUID

+ KeyCreatedAt *time.Time

+ KeyFingerprint string

+ MasterPublicKey string

+ Name string

+ Targets []string

+ UpdatedAt time.Time

type TargetKey

+ RingID uuid.UUID

Oct 15, 2026

Changes in this version

type Agent

+ AutoUpdate bool

+ SelfUpdate bool

+ UpdateError string

+ UpdateRequestedAt *time.Time

type AgentCapabilities

+ SelfUpdate bool

+ UpdateError string

+ Version string

type DB

+ func (d *DB) ClearAgentUpdateRequest(ctx context.Context, id uuid.UUID) error

+ func (d *DB) EnsureUnlimitedEnrollmentToken(ctx context.Context, tokenHash, name string) error

+ func (d *DB) RequestAgentUpdate(ctx context.Context, id uuid.UUID) error

+ func (d *DB) SetAgentAutoUpdate(ctx context.Context, id uuid.UUID, enabled bool) error

+ type HeartbeatState struct

+ Arch string

+ AutoUpdate bool

+ DebugLogging bool

+ OS string

+ UpdateRequested bool

Oct 10, 2026

Changes in this version

+ const JobTypeM365

+ var ErrTenantInUse = errors.New("tenant is referenced by backup jobs")

type BackupJob

+ M365Config *m365.Spec

+ func (j *BackupJob) IsM365() bool

type DB

+ func (d *DB) CreateTenant(ctx context.Context, t *m365.Tenant) error

+ func (d *DB) DeleteTenant(ctx context.Context, id uuid.UUID) error

+ func (d *DB) GetTenantByID(ctx context.Context, id uuid.UUID) (*m365.Tenant, error)

+ func (d *DB) ListTenants(ctx context.Context) ([]*m365.Tenant, error)

+ func (d *DB) UpdateTenant(ctx context.Context, t *m365.Tenant) error

Oct 9, 2026

Changes in this version

+ const EncryptionEncrypt

+ const EncryptionNone

type BackupRun

+ KeyFingerprint string

type BackupTarget

+ AuthToken string

+ EncryptionKeyID *uuid.UUID

+ EncryptionMode string

+ KeyCreatedAt *time.Time

+ KeyFingerprint string

+ MasterPublicKey string

+ func (t *BackupTarget) Encrypted() bool

type DB

+ Sealer *secrets.Sealer

+ func (d *DB) CountRunsWithKey(ctx context.Context, fingerprint string) (int, error)

+ func (d *DB) CreateTargetKey(ctx context.Context, k *TargetKey) error

+ func (d *DB) GetTargetKey(ctx context.Context, id uuid.UUID) (*TargetKey, error)

+ func (d *DB) ListTargetKeys(ctx context.Context, targetID uuid.UUID) ([]*TargetKey, error)

+ func (d *DB) RetireTargetKey(ctx context.Context, id uuid.UUID) error

+ func (d *DB) SealLegacySecrets(ctx context.Context) (int, error)

+ func (d *DB) SetTargetEncryption(ctx context.Context, targetID uuid.UUID, mode string, keyID *uuid.UUID) error

+ type TargetKey struct

+ CreatedAt time.Time

+ CreatedBy string

+ Fingerprint string

+ ID uuid.UUID

+ Key [32]byte

+ RetiredAt *time.Time

+ TargetID uuid.UUID

Sep 23, 2026

Changes in this version

type Agent

+ Inventory json.RawMessage

+ InventoryAt *time.Time

+ InventoryDetail json.RawMessage

+ InventoryDetailAt *time.Time

type AgentCapabilities

+ Inventory json.RawMessage

type DB

+ func (d *DB) ListRunsByAgent(ctx context.Context, agentID uuid.UUID, limit int) ([]*BackupRun, error)

+ func (d *DB) SetAgentInventoryDetail(ctx context.Context, id uuid.UUID, detail []byte) error

Sep 20, 2026

Changes in this version

+ func CleanDBEngines(in []string) []string

type Agent

+ DBEngines []string

+ func (a *Agent) CanRunDBEngine(engine string) bool

type AgentCapabilities

+ DBEngines []string

Sep 19, 2026

Changes in this version

type BackupJob

+ LastRun *JobLastRun

type DB

+ func (d *DB) LatestRunByJob(ctx context.Context) (map[uuid.UUID]*JobLastRun, error)

+ type JobLastRun struct

+ At time.Time

+ RunID uuid.UUID

+ Status RunStatus

Sep 18, 2026

Changes in this version

type DB

+ func (d *DB) BindTokenAgent(ctx context.Context, tokenID, agentID uuid.UUID) error

+ func (d *DB) CloneTarget(ctx context.Context, sourceID uuid.UUID, name, namespace, pxarFormat string) (*BackupTarget, error)

+ func (d *DB) GetEnrollmentToken(ctx context.Context, id uuid.UUID) (*EnrollmentToken, error)

type EnrollmentToken

+ AgentHostname string

+ AgentID *uuid.UUID

Sep 17, 2026

Changes in this version

type Agent

+ DBTools bool

+ func (a *Agent) CanRunJob(jobType string) bool

+ type AgentCapabilities struct

+ DBTools bool

+ DockerHost bool

+ PVEHost bool

type DB

+ func (d *DB) MergeAgents(ctx context.Context, from, into uuid.UUID) (int64, int64, error)

Sep 17, 2026

Changes in this version

+ const JobTypeDocker

type Agent

+ DockerHost bool

type BackupJob

+ DockerConfig *dockerbackup.Spec

+ func (j *BackupJob) IsDocker() bool

Sep 16, 2026

Changes in this version

+ func ValidateLocalBackupPaths(paths []string) ([]string, error)

Sep 13, 2026

Changes in this version

+ const JobTypePVE

+ func JobAllowedOnAgent(jobType, agentType string) bool

+ func NormalizeJobType(t string) (string, bool)

+ func ValidateBackupPathsFor(agentOS string, paths []string) ([]string, error)

type Agent

+ PVEHost bool

type BackupJob

+ PVEConfig *pvebackup.Spec

+ func (j *BackupJob) IsPVE() bool

Sep 6, 2026

Changes in this version

type BackupRun

+ Details json.RawMessage

+ Progress json.RawMessage

type DB

+ func (d *DB) SetRunItems(ctx context.Context, runID uuid.UUID, updatedAt string, ...) error

+ func (d *DB) SetRunPhase(ctx context.Context, runID uuid.UUID, phase, updatedAt string) error

+ func (d *DB) UpdateTarget(ctx context.Context, target *BackupTarget) error

Sep 5, 2026

Changes in this version

+ const AgentTypeKubernetes

+ const JobTypeKubernetes

+ func SetScheduleLocation(loc *time.Location)

type BackupJob

+ K8sConfig *k8sbackup.Spec

+ func (j *BackupJob) IsKubernetes() bool

Sep 4, 2026

Changes in this version

+ func ValidateCron(expr string) error

type Agent

+ DebugLogging bool

type BackupJob

+ func (j *BackupJob) NextRunString() string

type BackupRun

+ LogTail string

type DB

+ func (d *DB) SetAgentDebugLogging(ctx context.Context, id uuid.UUID, enabled bool) error

Sep 4, 2026

Changes in this version

+ const AgentTypeDatabase

+ const AgentTypeFilesystem

+ const JobTypeDatabase

+ const JobTypeFilesystem

+ const PxarFormatV1

+ const PxarFormatV2

+ func NormalizeAgentType(t string) (string, bool)

+ func ValidateBackupPaths(paths []string) ([]string, error)

+ func ValidateExcludePatterns(patterns []string) error

type Agent

+ AgentType string

type BackupJob

+ DBConfig *dbbackup.Spec

+ DirectPBS bool

+ JobType string

+ func (j *BackupJob) IsDatabase() bool

+ func (j *BackupJob) Sanitize() *BackupJob

+ func (j *BackupJob) Summary() string

type BackupRun

+ func (r *BackupRun) DurationString() string

type BackupTarget

+ HasToken bool

+ PxarFormat string

+ func (t *BackupTarget) Sanitize() *BackupTarget

type DB

+ func (d *DB) DeleteEnrollmentToken(ctx context.Context, id uuid.UUID) error

+ func (d *DB) UpdateJob(ctx context.Context, job *BackupJob) error

type EnrollmentToken

+ func (t *EnrollmentToken) Status() string

Aug 26, 2026

Changes in this version

type DB

+ func (d *DB) GetRunByID(ctx context.Context, id uuid.UUID) (*BackupRun, error)

+ func (d *DB) GetRunByWorkflowID(ctx context.Context, workflowID string) (*BackupRun, error)

+ func (d *DB) MarkRunStarted(ctx context.Context, id uuid.UUID, temporalRunID string, startedAt time.Time) error

+ func (d *DB) SetRunStatus(ctx context.Context, id uuid.UUID, status RunStatus, message string, ...) error

type RunStatus

+ const RunStatusCancelling

+ func (s RunStatus) IsActive() bool

Aug 26, 2026

Changes in this version

+ var ErrNotFound = errors.New("record not found")

+ type APIKey struct

+ CreatedAt time.Time

+ CreatedBy string

+ ExpiresAt *time.Time

+ ID uuid.UUID

+ KeyHash string

+ LastUsedAt *time.Time

+ Name string

+ RevokedAt *time.Time

+ type Agent struct

+ Arch string

+ CreatedAt time.Time

+ Hostname string

+ ID uuid.UUID

+ IPAddress string

+ LastSeenAt *time.Time

+ OS string

+ Status AgentStatus

+ TaskQueue string

+ UpdatedAt time.Time

+ Version string

+ type AgentAuthState struct

+ ID uuid.UUID

+ Revoked bool

+ TaskQueue string

+ TokenVersion int

+ type AgentStatus string

+ const AgentStatusBusy

+ const AgentStatusError

+ const AgentStatusOffline

+ const AgentStatusOnline

+ type BackupJob struct

+ AgentID uuid.UUID

+ AgentName string

+ BackupPaths []string

+ CreatedAt time.Time

+ Enabled bool

+ ExcludePaths []string

+ ID uuid.UUID

+ Name string

+ RetentionPolicy RetentionPolicy

+ ScheduleCron string

+ TargetID uuid.UUID

+ TargetName string

+ UpdatedAt time.Time

+ type BackupRun struct

+ AgentID uuid.UUID

+ AgentName string

+ BytesScanned int64

+ BytesUploaded int64

+ ChunkCount int

+ CreatedAt time.Time

+ DedupRatio float64

+ EndTime *time.Time

+ ErrorMessage string

+ ID uuid.UUID

+ JobID uuid.UUID

+ JobName string

+ PBSSnapshotID string

+ RunID string

+ StartTime *time.Time

+ Status RunStatus

+ TargetID uuid.UUID

+ WorkflowID string

+ type BackupTarget struct

+ AuthTokenEncrypted string

+ CreatedAt time.Time

+ Datastore string

+ Endpoint string

+ Fingerprint string

+ ID uuid.UUID

+ Name string

+ Namespace string

+ TLSVerify bool

+ TargetType string

+ UpdatedAt time.Time

+ type DB struct

+ Pool *pgxpool.Pool

+ func New(ctx context.Context, cfg config.DatabaseConfig) (*DB, error)

+ func (d *DB) BumpAgentTokenVersion(ctx context.Context, id uuid.UUID) (int, error)

+ func (d *DB) Close()

+ func (d *DB) CreateAPIKey(ctx context.Context, key *APIKey) error

+ func (d *DB) CreateAgent(ctx context.Context, agent *Agent) error

+ func (d *DB) CreateEnrollmentToken(ctx context.Context, token *EnrollmentToken) error

+ func (d *DB) CreateJob(ctx context.Context, job *BackupJob) error

+ func (d *DB) CreateRun(ctx context.Context, run *BackupRun) error

+ func (d *DB) CreateTarget(ctx context.Context, target *BackupTarget) error

+ func (d *DB) DeleteAgent(ctx context.Context, id uuid.UUID) error

+ func (d *DB) DeleteJob(ctx context.Context, id uuid.UUID) error

+ func (d *DB) DeleteTarget(ctx context.Context, id uuid.UUID) error

+ func (d *DB) GetAPIKeyByHash(ctx context.Context, hash string) (*APIKey, error)

+ func (d *DB) GetAgentAuthState(ctx context.Context, id uuid.UUID) (*AgentAuthState, error)

+ func (d *DB) GetAgentByID(ctx context.Context, id uuid.UUID) (*Agent, error)

+ func (d *DB) GetJobByID(ctx context.Context, id uuid.UUID) (*BackupJob, error)

+ func (d *DB) GetTargetByID(ctx context.Context, id uuid.UUID) (*BackupTarget, error)

+ func (d *DB) ListAPIKeys(ctx context.Context) ([]*APIKey, error)

+ func (d *DB) ListAgents(ctx context.Context) ([]*Agent, error)

+ func (d *DB) ListEnrollmentTokens(ctx context.Context) ([]*EnrollmentToken, error)

+ func (d *DB) ListJobs(ctx context.Context) ([]*BackupJob, error)

+ func (d *DB) ListRuns(ctx context.Context, limit int) ([]*BackupRun, error)

+ func (d *DB) ListTargets(ctx context.Context) ([]*BackupTarget, error)

+ func (d *DB) Migrate(ctx context.Context) error

+ func (d *DB) RevokeAPIKey(ctx context.Context, id uuid.UUID) error

+ func (d *DB) RevokeAgent(ctx context.Context, id uuid.UUID) error

+ func (d *DB) TouchAPIKey(ctx context.Context, id uuid.UUID) error

+ func (d *DB) UpdateAgentHeartbeat(ctx context.Context, id uuid.UUID, status AgentStatus) error

+ func (d *DB) UpdateRun(ctx context.Context, run *BackupRun) error

+ func (d *DB) UpsertAgent(ctx context.Context, agent *Agent) error

+ func (d *DB) ValidateAndConsumeToken(ctx context.Context, tokenHash string) (*EnrollmentToken, error)

+ type EnrollmentToken struct

+ CreatedAt time.Time

+ ExpiresAt time.Time

+ ID uuid.UUID

+ MaxUses int

+ Name string

+ TokenHash string

+ UsesCount int

+ type Migration struct

+ Name string

+ SQL string

+ Version int

+ func LoadMigrations() ([]Migration, error)

+ type RetentionPolicy struct

+ KeepDaily int

+ KeepLast int

+ KeepMonthly int

+ KeepWeekly int

+ KeepYearly int

+ func (r RetentionPolicy) ToJSON() []byte

+ type RunStatus string

+ const RunStatusCancelled

+ const RunStatusCompleted

+ const RunStatusFailed

+ const RunStatusPending

+ const RunStatusRunning