dbbackup

package

Go to main page

Versions in this module

v0

v0.0.7

Oct 27, 2026

Changes in this version

type KeyVerdict

+ KMS string

type PreflightOptions

+ KMS []secretbroker.KMS

type RestoreOptions

+ KMS []secretbroker.KMS

v0.0.6

Oct 16, 2026

Changes in this version

type Preflight

+ PreviousKeyFingerprint string

type PreflightOptions

+ Previous string

type RestoreOptions

+ Previous string

v0.0.5

Oct 12, 2026

Changes in this version

+ const EnvKey

+ const KeyStateLegacy

+ const KeyStateUnknown

+ const ManifestVersion

+ const OverrideAcceptSecretLoss

+ const OverrideAllowUnsealed

+ const OverrideSkipChecksum

+ var ErrChecksum = errors.New("dbbackup: checksum mismatch")

+ var ErrHubServing = errors.New("dbbackup: a hub is serving the destination database")

+ var ErrIntegrity = errors.New("dbbackup: the backup fails PRAGMA integrity_check")

+ var ErrNoReason = errors.New("dbbackup: a restore needs a reason; it is recorded with the restore")

+ var ErrNoSidecar = errors.New("dbbackup: the backup has no sidecar")

+ var ErrSchemaAhead = errors.New("dbbackup: the backup's schema is newer than this binary")

+ var ErrSealBroken = errors.New("dbbackup: the sidecar's seal does not verify")

+ var ErrSecretLoss = errors.New("dbbackup: the key cannot open the backup's sealing keys")

+ var ErrUnsealed = errors.New("dbbackup: the sidecar's seal cannot be checked")

+ func KeyFingerprint(passphrase string) string

+ type BackupOptions struct

+ Key string

type BackupReport

+ Chain *ManifestChain

+ KeyFingerprint string

+ Keys []ManifestKey

+ func BackupWithOptions(srcPath, outPath string, opts BackupOptions) (*BackupReport, error)

+ func (r *BackupReport) Sealed() bool

+ type KeyVerdict struct

+ Lost bool

+ Opens bool

+ Why string

+ type ManifestChain struct

+ AnchorHash string

+ AnchorID int64

+ AnchorThroughID int64

+ FirstID int64

+ LastID int64

+ LastRowHash string

+ LastTime string

+ Rows int64

+ type ManifestKey struct

+ ID string

+ Rows map[string]int

+ State string

+ func (k ManifestKey) Total() int

type Metadata

+ Chain *ManifestChain

+ KeyFingerprint string

+ Keys []ManifestKey

+ Manifest int

+ Seal string

+ func (m *Metadata) Check(key string) SealState

+ type Preflight struct

+ Backup string

+ Chain statedb.AuditHead

+ KeyFingerprint string

+ Keys []KeyVerdict

+ Meta *Metadata

+ Notes []string

+ Refusals []Refusal

+ SHA256 string

+ SchemaVersion int

+ Seal SealState

+ Sidecar SidecarState

+ SizeBytes int64

+ func Inspect(path string, opts PreflightOptions) (*Preflight, error)

+ func (p *Preflight) Err() error

+ func (p *Preflight) LostKeys() []KeyVerdict

+ type PreflightOptions struct

+ AcceptSecretLoss bool

+ AllowUnsealed bool

+ Key string

+ SkipChecksum bool

+ type Recording struct

+ Notes []string

+ Record auditcheckpoint.Record

+ RestoredHead statedb.AuditHead

+ RetiredKeys []string

+ Row statedb.AuditEvent

+ Sealed bool

+ Sinks []string

+ Superseded *auditcheckpoint.Located

+ type Refusal struct

+ Err error

+ Message string

+ Override string

+ type RefusedError struct

+ Backup string

+ Refusals []Refusal

+ func (e *RefusedError) Error() string

+ func (e *RefusedError) Is(target error) bool

type RestoreOptions

+ AcceptSecretLoss bool

+ Actor string

+ AllowUnsealed bool

+ Chain string

+ CheckpointFile string

+ CheckpointStderr io.Writer

+ Key string

+ Now func() time.Time

+ Reason string

type RestoreReport

+ Preflight *Preflight

+ Recorded Recording

+ type SealState string

+ const SealBad

+ const SealForeignKey

+ const SealUnchecked

+ const SealUnsigned

+ const SealValid

+ type SidecarState string

+ const SidecarBroken

+ const SidecarMissing

+ const SidecarSealed

+ const SidecarSkipped

+ const SidecarUnchecked

+ type UnrecordedError struct

+ Problems []string

+ func (e *UnrecordedError) Error() string

v0.0.4

Sep 27, 2026

v0.0.3

Sep 27, 2026

v0.0.2

Sep 17, 2026

v0.0.1

Sep 13, 2026

Changes in this version

+ const MetadataSuffix

+ type BackupReport struct

+ Duration time.Duration

+ MetadataPath string

+ Output string

+ SHA256 string

+ SchemaVersion int

+ SizeBytes int64

+ Source string

+ WALCheckpoint string

+ func Backup(srcPath, outPath string) (*BackupReport, error)

+ type Metadata struct

+ Backup string

+ CloopVersion string

+ CreatedAt time.Time

+ DurationMS int64

+ SHA256 string

+ SchemaVersion int

+ SizeBytes int64

+ Source string

+ func LoadMetadata(backupPath string) (*Metadata, error)

+ type RestoreOptions struct

+ Force bool

+ SkipChecksum bool

+ type RestoreReport struct

+ BackedUpPath string

+ Backup string

+ Destination string

+ Duration time.Duration

+ SizeBytes int64

+ func Restore(backupPath, dstPath string, opts RestoreOptions) (*RestoreReport, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL