storj/satellite/console/database.go

45 lines
1.4 KiB
Go
Raw Normal View History

2019-01-24 16:26:36 +00:00
// Copyright (C) 2019 Storj Labs, Inc.
// See LICENSE for copying information.
package console
import (
"context"
"storj.io/storj/satellite/console/consoleauth"
)
// DB contains access to different satellite databases.
2019-09-10 14:24:16 +01:00
//
// architecture: Database
type DB interface {
// Users is a getter for Users repository.
Users() Users
// Projects is a getter for Projects repository.
Projects() Projects
// ProjectMembers is a getter for ProjectMembers repository.
ProjectMembers() ProjectMembers
// APIKeys is a getter for APIKeys repository.
APIKeys() APIKeys
// RegistrationTokens is a getter for RegistrationTokens repository.
RegistrationTokens() RegistrationTokens
// ResetPasswordTokens is a getter for ResetPasswordTokens repository.
ResetPasswordTokens() ResetPasswordTokens
// WebappSessions is a getter for WebappSessions repository.
WebappSessions() consoleauth.WebappSessions
// AccountFreezeEvents is a getter for AccountFreezeEvents repository.
AccountFreezeEvents() AccountFreezeEvents
// WithTx is a method for executing transactions with retrying as necessary.
WithTx(ctx context.Context, fn func(ctx context.Context, tx DBTx) error) error
}
// DBTx extends Database with transaction scope.
type DBTx interface {
DB
// Commit is a method for committing and closing transaction.
Commit() error
// Rollback is a method for rollback and closing transaction.
Rollback() error
}