storj/satellite/console/database.go

41 lines
1.2 KiB
Go

// Copyright (C) 2019 Storj Labs, Inc.
// See LICENSE for copying information.
package console
import (
"context"
)
// DB contains access to different satellite databases.
//
// 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
// UserCredits is a getter for UserCredits repository.
UserCredits() UserCredits
// BeginTransaction is a method for opening transaction.
BeginTx(ctx context.Context) (DBTx, error)
}
// DBTx extends Database with transaction scope.
type DBTx interface {
DB
// CommitTransaction is a method for committing and closing transaction.
Commit() error
// RollbackTransaction is a method for rollback and closing transaction.
Rollback() error
}