store

Mar 15, 2026

Changes in this version

type S3Option

+ func WithS3Profile(profile string) S3Option

Mar 5, 2026

Changes in this version

+ type B2Option func(*b2Options)

+ func WithClient(client *b2.Client) B2Option

+ func WithCredentials(keyID, appKey string) B2Option

+ func WithPrefix(prefix string) B2Option

+ type S3Option func(*s3Options)

+ func WithS3Client(client *s3.Client) S3Option

+ func WithS3Credentials(accessKey, secretKey string) S3Option

+ func WithS3Endpoint(endpoint string) S3Option

+ func WithS3Prefix(prefix string) S3Option

+ func WithS3Region(region string) S3Option

+ type SFTPStoreOption func(*sftpStoreOptions)

+ func WithSFTPBasePath(basePath string) SFTPStoreOption

+ func WithSFTPClient(client *sftp.Client) SFTPStoreOption

+ func WithSFTPKey(keyPath string) SFTPStoreOption

+ func WithSFTPPassword(password string) SFTPStoreOption

+ func WithSFTPPort(port string) SFTPStoreOption

+ func WithSFTPUser(user string) SFTPStoreOption

Mar 4, 2026

Changes in this version

+ func InitKMSEncryptionKey(ctx context.Context, s ObjectStore, encrypter crypto.KMSEncrypter, ...) ([]byte, error)

+ func WriteKMSSlot(ctx context.Context, s ObjectStore, masterKey []byte, ...) error

type SFTPConfig

+ BasePath string

Mar 3, 2026

Changes in this version

+ func ChangePasswordSlot(s ObjectStore, masterKey []byte, newPassword string) error

+ func ParseExcludeFile(path string) ([]string, error)

+ type ExcludeMatcher struct

+ func NewExcludeMatcher(patterns []string) *ExcludeMatcher

+ func (m *ExcludeMatcher) Empty() bool

+ func (m *ExcludeMatcher) Excludes(relPath string, isDir bool) bool

+ type GDriveSourceConfig struct

+ CredsPath string

+ DriveID string

+ ExcludePatterns []string

+ RootFolderID string

+ TokenPath string

+ type LocalSourceConfig struct

+ ExcludePatterns []string

+ RootPath string

+ type OneDriveSourceConfig struct

+ ClientID string

+ ExcludePatterns []string

+ TokenPath string

+ type SFTPSourceConfig struct

+ ExcludePatterns []string

+ RootPath string

Mar 3, 2026

Changes in this version

+ func ExtractMasterKeyWithKMS(ctx context.Context, slots []KeySlot, decrypter crypto.KMSDecrypter, ...) ([]byte, error)

+ func OpenWithKMS(ctx context.Context, slots []KeySlot, decrypter crypto.KMSDecrypter) ([]byte, error)

Mar 1, 2026

Changes in this version

type PackStore

+ func (s *PackStore) Repack(ctx context.Context, maxWastedRatio float64) (int64, int, error)

Mar 1, 2026

Changes in this version

+ func GetConcurrencyHint(s ObjectStore, defaultConcurrency int) int

type B2Store

+ func (s *B2Store) Flush(ctx context.Context) error

type CompressedStore

+ func (s *CompressedStore) Flush(ctx context.Context) error

+ func (s *CompressedStore) Unwrap() ObjectStore

+ type ConcurrencyHinter interface

+ ConcurrencyHint func() int

type DebugStore

+ func (s *DebugStore) Flush(ctx context.Context) error

+ func (s *DebugStore) Unwrap() ObjectStore

type EncryptedStore

+ func (s *EncryptedStore) Unwrap() ObjectStore

type HybridStore

+ func (s *HybridStore) Flush(ctx context.Context) error

+ func (s *HybridStore) Unwrap() ObjectStore

type KeyCacheStore

+ func (s *KeyCacheStore) Flush(ctx context.Context) error

+ func (s *KeyCacheStore) Unwrap() ObjectStore

type LocalStore

+ func (s *LocalStore) Flush(ctx context.Context) error

type MeteredStore

+ func (m *MeteredStore) Unwrap() ObjectStore

type ObjectStore

+ Flush func(ctx context.Context) error

+ type PackEntry struct

+ Length int64

+ Offset int64

+ PackRef string

+ type PackStore struct

+ func NewPackStore(inner ObjectStore) (*PackStore, error)

+ func (s *PackStore) Delete(ctx context.Context, key string) error

+ func (s *PackStore) Exists(ctx context.Context, key string) (bool, error)

+ func (s *PackStore) Flush(ctx context.Context) error

+ func (s *PackStore) Get(ctx context.Context, key string) ([]byte, error)

+ func (s *PackStore) List(ctx context.Context, prefix string) ([]string, error)

+ func (s *PackStore) Put(ctx context.Context, key string, data []byte) error

+ func (s *PackStore) Size(ctx context.Context, key string) (int64, error)

+ func (s *PackStore) TotalSize(ctx context.Context) (int64, error)

type QuotaStore

+ func (q *QuotaStore) Unwrap() ObjectStore

type S3Store

+ func (s *S3Store) ConcurrencyHint() int

+ func (s *S3Store) Flush(ctx context.Context) error

type SFTPStore

+ func (s *SFTPStore) Flush(ctx context.Context) error

+ type Unwrapper interface

+ Unwrap func() ObjectStore

Feb 28, 2026

Changes in this version

type HybridStore

+ func (s *HybridStore) Store() ObjectStore

Feb 28, 2026

Changes in this version

+ type SFTPConfig struct

+ Host string

+ Password string

+ Port string

+ PrivateKeyPath string

+ User string

+ type SFTPSource struct

+ func NewSFTPSource(cfg SFTPConfig, rootPath string) (*SFTPSource, error)

+ func (s *SFTPSource) Close() error

+ func (s *SFTPSource) GetFileStream(fileID string) (io.ReadCloser, error)

+ func (s *SFTPSource) Info() core.SourceInfo

+ func (s *SFTPSource) Size(ctx context.Context) (*SourceSize, error)

+ func (s *SFTPSource) Walk(ctx context.Context, callback func(core.FileMeta) error) error

+ type SFTPStore struct

+ func NewSFTPStore(cfg SFTPConfig, basePath string) (*SFTPStore, error)

+ func (s *SFTPStore) Close() error

+ func (s *SFTPStore) Delete(_ context.Context, key string) error

+ func (s *SFTPStore) Exists(_ context.Context, key string) (bool, error)

+ func (s *SFTPStore) Get(_ context.Context, key string) ([]byte, error)

+ func (s *SFTPStore) List(_ context.Context, prefix string) ([]string, error)

+ func (s *SFTPStore) Put(_ context.Context, key string, data []byte) error

+ func (s *SFTPStore) Size(_ context.Context, key string) (int64, error)

+ func (s *SFTPStore) TotalSize(_ context.Context) (int64, error)

Feb 28, 2026

Changes in this version

+ type S3Store struct

+ BucketName string

+ Client *s3.Client

+ Prefix string

+ func NewS3Store(ctx context.Context, ...) (*S3Store, error)

+ func (s *S3Store) Delete(ctx context.Context, key string) error

+ func (s *S3Store) Exists(ctx context.Context, key string) (bool, error)

+ func (s *S3Store) Get(ctx context.Context, key string) ([]byte, error)

+ func (s *S3Store) List(ctx context.Context, prefix string) ([]string, error)

+ func (s *S3Store) Put(ctx context.Context, key string, data []byte) error

+ func (s *S3Store) Size(ctx context.Context, key string) (int64, error)

+ func (s *S3Store) TotalSize(ctx context.Context) (int64, error)

Feb 27, 2026

Changes in this version

+ type DebugStore struct

+ func NewDebugStore(inner ObjectStore, w io.Writer) *DebugStore

+ func (s *DebugStore) Delete(ctx context.Context, key string) error

+ func (s *DebugStore) Exists(ctx context.Context, key string) (bool, error)

+ func (s *DebugStore) Get(ctx context.Context, key string) ([]byte, error)

+ func (s *DebugStore) List(ctx context.Context, prefix string) ([]string, error)

+ func (s *DebugStore) Put(ctx context.Context, key string, data []byte) error

+ func (s *DebugStore) Size(ctx context.Context, key string) (int64, error)

+ func (s *DebugStore) TotalSize(ctx context.Context) (int64, error)

Feb 27, 2026

Changes in this version

+ type CompressedStore struct

+ func NewCompressedStore(inner ObjectStore) *CompressedStore

+ func (s *CompressedStore) Delete(ctx context.Context, key string) error

+ func (s *CompressedStore) Exists(ctx context.Context, key string) (bool, error)

+ func (s *CompressedStore) Get(ctx context.Context, key string) ([]byte, error)

+ func (s *CompressedStore) List(ctx context.Context, prefix string) ([]string, error)

+ func (s *CompressedStore) Put(ctx context.Context, key string, data []byte) error

+ func (s *CompressedStore) Size(ctx context.Context, key string) (int64, error)

+ func (s *CompressedStore) TotalSize(ctx context.Context) (int64, error)

+ type KeyCacheStore struct

+ func NewKeyCacheStore(inner ObjectStore) *KeyCacheStore

+ func (s *KeyCacheStore) Delete(ctx context.Context, key string) error

+ func (s *KeyCacheStore) Exists(ctx context.Context, key string) (bool, error)

+ func (s *KeyCacheStore) Get(ctx context.Context, key string) ([]byte, error)

+ func (s *KeyCacheStore) List(ctx context.Context, prefix string) ([]string, error)

+ func (s *KeyCacheStore) PreloadKeys(ctx context.Context, prefixes ...string) error

+ func (s *KeyCacheStore) Put(ctx context.Context, key string, data []byte) error

+ func (s *KeyCacheStore) Size(ctx context.Context, key string) (int64, error)

+ func (s *KeyCacheStore) TotalSize(ctx context.Context) (int64, error)

Feb 26, 2026

Changes in this version

+ const KeySlotPrefix

+ var ErrQuotaExceeded = errors.New("storage quota exceeded during backup")

+ func AddRecoverySlot(s ObjectStore, masterKey []byte) (mnemonic string, err error)

+ func ExtractMasterKey(slots []KeySlot, platformKey []byte, password string) ([]byte, error)

+ func HasKeySlots(s ObjectStore) bool

+ func InitEncryptionKey(s ObjectStore, platformKey []byte, password string) ([]byte, error)

+ func OpenWithPassword(slots []KeySlot, password string) ([]byte, error)

+ func OpenWithPlatformKey(slots []KeySlot, platformKey []byte) ([]byte, error)

+ func OpenWithRecoveryKey(slots []KeySlot, recoveryKey []byte) ([]byte, error)

+ func SlotTypes(slots []KeySlot) string

+ func SyncKeySlots(s ObjectStore, slots []KeySlot)

+ type B2Store struct

+ Bucket *b2.Bucket

+ Client *b2.Client

+ Prefix string

+ func NewB2Store(keyID, appKey, bucketName string) (*B2Store, error)

+ func NewB2StoreWithPrefix(keyID, appKey, bucketName, prefix string) (*B2Store, error)

+ func (s *B2Store) Delete(key string) error

+ func (s *B2Store) DeletePrefix(prefix string) error

+ func (s *B2Store) Exists(key string) (bool, error)

+ func (s *B2Store) Get(key string) ([]byte, error)

+ func (s *B2Store) List(prefix string) ([]string, error)

+ func (s *B2Store) NewWriter(key string) io.WriteCloser

+ func (s *B2Store) Put(key string, data []byte) error

+ func (s *B2Store) SignedURL(key string, validFor time.Duration) (string, error)

+ func (s *B2Store) Size(key string) (int64, error)

+ func (s *B2Store) TotalSize() (int64, error)

+ type ChangeType string

+ const ChangeDelete

+ const ChangeUpsert

+ type EncryptedStore struct

+ func NewEncryptedStore(inner ObjectStore, key []byte) *EncryptedStore

+ func (s *EncryptedStore) Get(key string) ([]byte, error)

+ func (s *EncryptedStore) Put(key string, data []byte) error

+ type FileChange struct

+ Meta core.FileMeta

+ Type ChangeType

+ type GDriveChangeSource struct

+ func NewGDriveChangeSource(credsPath, tokenPath string) (*GDriveChangeSource, error)

+ func (s *GDriveChangeSource) GetStartPageToken() (string, error)

+ func (s *GDriveChangeSource) Info() core.SourceInfo

+ func (s *GDriveChangeSource) WalkChanges(ctx context.Context, token string, callback func(FileChange) error) (string, error)

+ type GDriveSource struct

+ Account string

+ DriveID string

+ RootFolderID string

+ Service *drive.Service

+ func NewGDriveSource(credsPath, tokenPath string) (*GDriveSource, error)

+ func (s *GDriveSource) GetFileStream(fileID string) (io.ReadCloser, error)

+ func (s *GDriveSource) Info() core.SourceInfo

+ func (s *GDriveSource) Size(ctx context.Context) (*SourceSize, error)

+ func (s *GDriveSource) Walk(ctx context.Context, callback func(core.FileMeta) error) error

+ type HybridStore struct

+ func NewHybridStore(db TxFunc, b2 *B2Store) *HybridStore

+ func (s *HybridStore) B2() *B2Store

+ func (s *HybridStore) DB() TxFunc

+ func (s *HybridStore) Delete(key string) error

+ func (s *HybridStore) Exists(key string) (bool, error)

+ func (s *HybridStore) Get(key string) ([]byte, error)

+ func (s *HybridStore) List(prefix string) ([]string, error)

+ func (s *HybridStore) Put(key string, data []byte) error

+ func (s *HybridStore) Size(key string) (int64, error)

+ func (s *HybridStore) TotalSize() (int64, error)

+ type IncrementalSource interface

+ GetStartPageToken func() (string, error)

+ WalkChanges func(ctx context.Context, token string, callback func(FileChange) error) (newToken string, err error)

+ type KDFParams struct

+ Algorithm string

+ Memory uint32

+ Salt string

+ Threads uint8

+ Time uint32

+ type KeySlot struct

+ KDFParams *KDFParams

+ Label string

+ SlotType string

+ WrappedKey string

+ func LoadKeySlots(s ObjectStore) ([]KeySlot, error)

+ func LoadKeySlotsFromDB(db TxFunc) ([]KeySlot, error)

+ type LocalSource struct

+ RootPath string

+ func NewLocalSource(rootPath string) *LocalSource

+ func (s *LocalSource) GetFileStream(fileID string) (io.ReadCloser, error)

+ func (s *LocalSource) Info() core.SourceInfo

+ func (s *LocalSource) Size(ctx context.Context) (*SourceSize, error)

+ func (s *LocalSource) Walk(ctx context.Context, callback func(core.FileMeta) error) error

+ type LocalStore struct

+ BasePath string

+ func NewLocalStore(basePath string) (*LocalStore, error)

+ func (s *LocalStore) Delete(key string) error

+ func (s *LocalStore) Exists(key string) (bool, error)

+ func (s *LocalStore) Get(key string) ([]byte, error)

+ func (s *LocalStore) List(prefix string) ([]string, error)

+ func (s *LocalStore) Put(key string, data []byte) error

+ func (s *LocalStore) Size(key string) (int64, error)

+ func (s *LocalStore) TotalSize() (int64, error)

+ type MeteredStore struct

+ func NewMeteredStore(s ObjectStore) *MeteredStore

+ func (m *MeteredStore) BytesWritten() int64

+ func (m *MeteredStore) Delete(key string) error

+ func (m *MeteredStore) DeleteReturnSize(key string) (int64, error)

+ func (m *MeteredStore) Put(key string, data []byte) error

+ func (m *MeteredStore) Reset()

+ type ObjectStore interface

+ Delete func(key string) error

+ Exists func(key string) (bool, error)

+ Get func(key string) ([]byte, error)

+ List func(prefix string) ([]string, error)

+ Put func(key string, data []byte) error

+ Size func(key string) (int64, error)

+ TotalSize func() (int64, error)

+ type OneDriveChangeSource struct

+ func NewOneDriveChangeSource(clientID, clientSecret, tokenPath string) (*OneDriveChangeSource, error)

+ func (s *OneDriveChangeSource) GetStartPageToken() (string, error)

+ func (s *OneDriveChangeSource) Info() core.SourceInfo

+ func (s *OneDriveChangeSource) WalkChanges(ctx context.Context, token string, callback func(FileChange) error) (string, error)

+ type OneDriveSource struct

+ Client *http.Client

+ func NewOneDriveSource(clientID, clientSecret, tokenPath string) (*OneDriveSource, error)

+ func (s *OneDriveSource) GetFileStream(fileID string) (io.ReadCloser, error)

+ func (s *OneDriveSource) Info() core.SourceInfo

+ func (s *OneDriveSource) Size(ctx context.Context) (*SourceSize, error)

+ func (s *OneDriveSource) Walk(ctx context.Context, callback func(core.FileMeta) error) error

+ type QuotaStore struct

+ func NewQuotaStore(inner ObjectStore, budget int64, cancel context.CancelCauseFunc) *QuotaStore

+ func (q *QuotaStore) Put(key string, data []byte) error

+ func (q *QuotaStore) Written() int64

+ type Source interface

+ GetFileStream func(fileID string) (io.ReadCloser, error)

+ Info func() core.SourceInfo

+ Size func(ctx context.Context) (*SourceSize, error)

+ Walk func(ctx context.Context, callback func(core.FileMeta) error) error

+ type SourceSize struct

+ Bytes int64

+ Files int64

+ type TxFunc func(fn func(ctx context.Context, tx pgx.Tx) error) error