b5ddfc6fa5
Backstory: I needed a better way to pass around information about the underlying driver and implementation to all the various db-using things in satellitedb (at least until some new "cockroach driver" support makes it to DBX). After hitting a few dead ends, I decided I wanted to have a type that could act like a *dbx.DB but which would also carry information about the implementation, etc. Then I could pass around that type to all the things in satellitedb that previously wanted *dbx.DB. But then I realized that *satellitedb.DB was, essentially, exactly that already. One thing that might have kept *satellitedb.DB from being directly usable was that embedding a *dbx.DB inside it would make a lot of dbx methods publicly available on a *satellitedb.DB instance that previously were nicely encapsulated and hidden. But after a quick look, I realized that _nothing_ outside of satellite/satellitedb even needs to use satellitedb.DB at all. It didn't even need to be exported, except for some trivially-replaceable code in migrate_postgres_test.go. And once I made it unexported, any concerns about exposing new methods on it were entirely moot. So I have here changed the exported *satellitedb.DB type into the unexported *satellitedb.satelliteDB type, and I have changed all the places here that wanted raw dbx.DB handles to use this new type instead. Now they can just take a gander at the implementation member on it and know all they need to know about the underlying database. This will make it possible for some other pending code here to differentiate between postgres and cockroach backends. Change-Id: I27af99f8ae23b50782333da5277b553b34634edc
104 lines
2.4 KiB
Go
104 lines
2.4 KiB
Go
// Copyright (C) 2019 Storj Labs, Inc.
|
|
// See LICENSE for copying information.
|
|
|
|
package satellitedb
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/zeebo/errs"
|
|
|
|
"storj.io/storj/satellite/console"
|
|
dbx "storj.io/storj/satellite/satellitedb/dbx"
|
|
)
|
|
|
|
// ensures that ConsoleDB implements console.DB.
|
|
var _ console.DB = (*ConsoleDB)(nil)
|
|
|
|
// ConsoleDB contains access to different satellite databases.
|
|
type ConsoleDB struct {
|
|
db *satelliteDB
|
|
tx *dbx.Tx
|
|
|
|
methods dbx.Methods
|
|
}
|
|
|
|
// Users is getter a for Users repository.
|
|
func (db *ConsoleDB) Users() console.Users {
|
|
return &users{db.methods}
|
|
}
|
|
|
|
// Projects is a getter for Projects repository.
|
|
func (db *ConsoleDB) Projects() console.Projects {
|
|
return &projects{db.methods}
|
|
}
|
|
|
|
// ProjectMembers is a getter for ProjectMembers repository.
|
|
func (db *ConsoleDB) ProjectMembers() console.ProjectMembers {
|
|
return &projectMembers{db.methods, db.db}
|
|
}
|
|
|
|
// APIKeys is a getter for APIKeys repository.
|
|
func (db *ConsoleDB) APIKeys() console.APIKeys {
|
|
return &apikeys{db.methods, db.db}
|
|
}
|
|
|
|
// RegistrationTokens is a getter for RegistrationTokens repository.
|
|
func (db *ConsoleDB) RegistrationTokens() console.RegistrationTokens {
|
|
return ®istrationTokens{db.methods}
|
|
}
|
|
|
|
// ResetPasswordTokens is a getter for ResetPasswordTokens repository.
|
|
func (db *ConsoleDB) ResetPasswordTokens() console.ResetPasswordTokens {
|
|
return &resetPasswordTokens{db.methods}
|
|
}
|
|
|
|
// UserCredits is a getter for console.UserCredits repository.
|
|
func (db *ConsoleDB) UserCredits() console.UserCredits {
|
|
return &usercredits{db.db, db.tx}
|
|
}
|
|
|
|
// BeginTx is a method for opening transaction.
|
|
func (db *ConsoleDB) BeginTx(ctx context.Context) (console.DBTx, error) {
|
|
if db.db == nil {
|
|
return nil, errs.New("DB is not initialized!")
|
|
}
|
|
|
|
tx, err := db.db.Open(ctx)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &DBTx{
|
|
ConsoleDB: &ConsoleDB{
|
|
// Need to expose dbx.DB for when database methods need access to check database driver type
|
|
db: db.db,
|
|
tx: tx,
|
|
methods: tx,
|
|
},
|
|
}, nil
|
|
}
|
|
|
|
// DBTx extends Database with transaction scope.
|
|
type DBTx struct {
|
|
*ConsoleDB
|
|
}
|
|
|
|
// Commit is a method for committing and closing transaction.
|
|
func (db *DBTx) Commit() error {
|
|
if db.tx == nil {
|
|
return errs.New("begin transaction before commit it!")
|
|
}
|
|
|
|
return db.tx.Commit()
|
|
}
|
|
|
|
// Rollback is a method for rollback and closing transaction.
|
|
func (db *DBTx) Rollback() error {
|
|
if db.tx == nil {
|
|
return errs.New("begin transaction before rollback it!")
|
|
}
|
|
|
|
return db.tx.Rollback()
|
|
}
|