sourcegraph/internal/database/database.go

package database

import (
	"context"
	"database/sql"

	"github.com/sourcegraph/log"

	"github.com/sourcegraph/sourcegraph/internal/database/basestore"
	"github.com/sourcegraph/sourcegraph/internal/database/dbconn"
	"github.com/sourcegraph/sourcegraph/internal/database/dbutil"
	"github.com/sourcegraph/sourcegraph/internal/encryption"
)

// DB is an interface that embeds dbutil.DB, adding methods to
// return specialized stores on top of that interface. In time,
// the expectation is to replace uses of dbutil.DB with database.DB,
// and remove dbutil.DB altogether.
type DB interface {
	dbutil.DB
	basestore.ShareableStore

	AccessTokens() AccessTokenStore
	Authz() AuthzStore
	BitbucketProjectPermissions() BitbucketProjectPermissionsStore
	Conf() ConfStore
	EventLogs() EventLogStore
	SecurityEventLogs() SecurityEventLogsStore
	ExternalServices() ExternalServiceStore
	FeatureFlags() FeatureFlagStore
	GitserverRepos() GitserverRepoStore
	GitserverLocalClone() GitserverLocalCloneStore
	GlobalState() GlobalStateStore
	Namespaces() NamespaceStore
	OrgInvitations() OrgInvitationStore
	OrgMembers() OrgMemberStore
	Orgs() OrgStore
	OrgStats() OrgStatsStore
	Permissions() PermissionStore
	PermissionSyncJobs() PermissionSyncJobStore
	Phabricator() PhabricatorStore
	Repos() RepoStore
	RepoKVPs() RepoKVPStore
	RolePermissions() RolePermissionStore
	Roles() RoleStore
	SavedSearches() SavedSearchStore
	SearchContexts() SearchContextsStore
	Settings() SettingsStore
	TemporarySettings() TemporarySettingsStore
	UserCredentials(encryption.Key) UserCredentialsStore
	UserEmails() UserEmailsStore
	UserExternalAccounts() UserExternalAccountsStore
	UserRoles() UserRoleStore
	Users() UserStore
	WebhookLogs(encryption.Key) WebhookLogStore
	Webhooks(encryption.Key) WebhookStore
	RepoStatistics() RepoStatisticsStore
	Executors() ExecutorStore
	ExecutorSecrets(encryption.Key) ExecutorSecretStore
	ExecutorSecretAccessLogs() ExecutorSecretAccessLogStore
	ZoektRepos() ZoektReposStore

	Transact(context.Context) (DB, error)
	Done(error) error
}

var _ DB = (*db)(nil)

// NewDB creates a new DB from a dbutil.DB, providing a thin wrapper
// that has constructor methods for the more specialized stores.
func NewDB(logger log.Logger, inner *sql.DB) DB {
	return &db{logger: logger, Store: basestore.NewWithHandle(basestore.NewHandleWithDB(logger, inner, sql.TxOptions{}))}
}

func NewDBWith(logger log.Logger, other basestore.ShareableStore) DB {
	return &db{logger: logger, Store: basestore.NewWithHandle(other.Handle())}
}

type db struct {
	*basestore.Store
	logger log.Logger
}

func (d *db) QueryContext(ctx context.Context, q string, args ...any) (*sql.Rows, error) {
	return d.Handle().QueryContext(dbconn.SkipFrameForQuerySource(ctx), q, args...)
}

func (d *db) ExecContext(ctx context.Context, q string, args ...any) (sql.Result, error) {
	return d.Handle().ExecContext(dbconn.SkipFrameForQuerySource(ctx), q, args...)
}

func (d *db) QueryRowContext(ctx context.Context, q string, args ...any) *sql.Row {
	return d.Handle().QueryRowContext(dbconn.SkipFrameForQuerySource(ctx), q, args...)
}

func (d *db) Transact(ctx context.Context) (DB, error) {
	tx, err := d.Store.Transact(ctx)
	if err != nil {
		return nil, err
	}
	return &db{logger: d.logger, Store: tx}, nil
}

func (d *db) Done(err error) error {
	return d.Store.Done(err)
}

func (d *db) AccessTokens() AccessTokenStore {
	return AccessTokensWith(d.Store, d.logger.Scoped("AccessTokenStore", ""))
}

func (d *db) BitbucketProjectPermissions() BitbucketProjectPermissionsStore {
	return BitbucketProjectPermissionsStoreWith(d.Store)
}

func (d *db) Authz() AuthzStore {
	return AuthzWith(d.Store)
}

func (d *db) Conf() ConfStore {
	return &confStore{Store: basestore.NewWithHandle(d.Handle())}
}

func (d *db) EventLogs() EventLogStore {
	return EventLogsWith(d.Store)
}

func (d *db) SecurityEventLogs() SecurityEventLogsStore {
	return SecurityEventLogsWith(d.logger, d.Store)
}

func (d *db) ExternalServices() ExternalServiceStore {
	return ExternalServicesWith(d.logger, d.Store)
}

func (d *db) FeatureFlags() FeatureFlagStore {
	return FeatureFlagsWith(d.Store)
}

func (d *db) GitserverRepos() GitserverRepoStore {
	return GitserverReposWith(d.Store)
}

func (d *db) GitserverLocalClone() GitserverLocalCloneStore {
	return GitserverLocalCloneStoreWith(d.Store)
}

func (d *db) GlobalState() GlobalStateStore {
	return GlobalStateWith(d.Store)
}

func (d *db) Namespaces() NamespaceStore {
	return NamespacesWith(d.Store)
}

func (d *db) OrgInvitations() OrgInvitationStore {
	return OrgInvitationsWith(d.Store)
}

func (d *db) OrgMembers() OrgMemberStore {
	return OrgMembersWith(d.Store)
}

func (d *db) Orgs() OrgStore {
	return OrgsWith(d.Store)
}

func (d *db) OrgStats() OrgStatsStore {
	return OrgStatsWith(d.Store)
}

func (d *db) Permissions() PermissionStore {
	return PermissionsWith(d.Store)
}

func (d *db) PermissionSyncJobs() PermissionSyncJobStore {
	return PermissionSyncJobsWith(d.logger, d.Store)
}

func (d *db) Phabricator() PhabricatorStore {
	return PhabricatorWith(d.Store)
}

func (d *db) Repos() RepoStore {
	return ReposWith(d.logger, d.Store)
}

func (d *db) RepoKVPs() RepoKVPStore {
	return &repoKVPStore{d.Store}
}

func (d *db) RolePermissions() RolePermissionStore {
	return RolePermissionsWith(d.Store)
}

func (d *db) Roles() RoleStore {
	return RolesWith(d.Store)
}

func (d *db) SavedSearches() SavedSearchStore {
	return SavedSearchesWith(d.Store)
}

func (d *db) SearchContexts() SearchContextsStore {
	return SearchContextsWith(d.logger, d.Store)
}

func (d *db) Settings() SettingsStore {
	return SettingsWith(d.Store)
}

func (d *db) TemporarySettings() TemporarySettingsStore {
	return TemporarySettingsWith(d.Store)
}

func (d *db) UserCredentials(key encryption.Key) UserCredentialsStore {
	return UserCredentialsWith(d.logger, d.Store, key)
}

func (d *db) UserEmails() UserEmailsStore {
	return UserEmailsWith(d.Store)
}

func (d *db) UserExternalAccounts() UserExternalAccountsStore {
	return ExternalAccountsWith(d.logger, d.Store)
}

func (d *db) UserRoles() UserRoleStore {
	return UserRolesWith(d.Store)
}

func (d *db) Users() UserStore {
	return UsersWith(d.logger, d.Store)
}

func (d *db) WebhookLogs(key encryption.Key) WebhookLogStore {
	return WebhookLogsWith(d.Store, key)
}

func (d *db) Webhooks(key encryption.Key) WebhookStore {
	return WebhooksWith(d.Store, key)
}

func (d *db) RepoStatistics() RepoStatisticsStore {
	return RepoStatisticsWith(d.Store)
}

func (d *db) Executors() ExecutorStore {
	return ExecutorsWith(d.Store)
}

func (d *db) ExecutorSecrets(key encryption.Key) ExecutorSecretStore {
	return ExecutorSecretsWith(d.logger, d.Store, key)
}

func (d *db) ExecutorSecretAccessLogs() ExecutorSecretAccessLogStore {
	return ExecutorSecretAccessLogsWith(d.Store)
}

func (d *db) ZoektRepos() ZoektReposStore {
	return ZoektReposWith(d.Store)
}