bundb

Documentation

Index

• func NewBunDBService(ctx context.Context, state *state.State) (db.DB, error)
• type DBConn
  • func WrapDBConn(dbConn *bun.DB) *DBConn
  • func (conn *DBConn) Exists(ctx context.Context, query *bun.SelectQuery) (bool, db.Error)
  • func (conn *DBConn) NotExists(ctx context.Context, query *bun.SelectQuery) (bool, db.Error)
  • func (conn *DBConn) ProcessError(err error) db.Error
  • func (conn *DBConn) RunInTx(ctx context.Context, fn func(bun.Tx) error) db.Error
• type DBService
  • func (dbService *DBService) GetConn() *DBConn
  • func (dbService *DBService) TagStringToTag(ctx context.Context, t string, originAccountID string) (*gtsmodel.Tag, error)

Functions

func NewBunDBService

func NewBunDBService(ctx context.Context, state *state.State) (db.DB, error)

NewBunDBService returns a bunDB derived from the provided config, which implements the go-fed DB interface. Under the hood, it uses https://github.com/uptrace/bun to create and maintain a database connection.

Types

type DBConn

type DBConn struct {
	*bun.DB // DB is the underlying bun.DB connection
	// contains filtered or unexported fields
}

DBConn wrapps a bun.DB conn to provide SQL-type specific additional functionality

func WrapDBConn

func WrapDBConn(dbConn *bun.DB) *DBConn

WrapDBConn wraps a bun DB connection to provide our own error processing dependent on DB dialect.

func (*DBConn) Exists

func (conn *DBConn) Exists(ctx context.Context, query *bun.SelectQuery) (bool, db.Error)

Exists checks the results of a SelectQuery for the existence of the data in question, masking ErrNoEntries errors

func (*DBConn) NotExists

func (conn *DBConn) NotExists(ctx context.Context, query *bun.SelectQuery) (bool, db.Error)

NotExists is the functional opposite of conn.Exists()

func (*DBConn) ProcessError

func (conn *DBConn) ProcessError(err error) db.Error

ProcessError processes an error to replace any known values with our own db.Error types, making it easier to catch specific situations (e.g. no rows, already exists, etc)

func (*DBConn) RunInTx

func (conn *DBConn) RunInTx(ctx context.Context, fn func(bun.Tx) error) db.Error

RunInTx wraps execution of the supplied transaction function.

type DBService

type DBService struct {
	db.Account
	db.Admin
	db.Basic
	db.Domain
	db.Emoji
	db.Instance
	db.Media
	db.Mention
	db.Notification
	db.Relationship
	db.Report
	db.Session
	db.Status
	db.StatusBookmark
	db.StatusFave
	db.Timeline
	db.User
	db.Tombstone
	// contains filtered or unexported fields
}

DBService satisfies the DB interface

func (*DBService) GetConn

func (dbService *DBService) GetConn() *DBConn

GetConn returns the underlying bun connection. Should only be used in testing + exceptional circumstance.

func (*DBService) TagStringToTag

func (dbService *DBService) TagStringToTag(ctx context.Context, t string, originAccountID string) (*gtsmodel.Tag, error)