bundb

Documentation

Index

• func NewBunDBService(ctx context.Context, state *state.State) (db.DB, error)
• type DBService
  • func (dbService *DBService) DB() *bun.DB
• type UpsertQuery
  • func NewUpsert(idb bun.IDB) *UpsertQuery
  • func (u *UpsertQuery) Column(columns ...string) *UpsertQuery
  • func (u *UpsertQuery) Constraint(constraints ...string) *UpsertQuery
  • func (u *UpsertQuery) Exec(ctx context.Context, dest ...interface{}) (sql.Result, error)
  • func (u *UpsertQuery) Model(model interface{}) *UpsertQuery
  • func (u *UpsertQuery) Scan(ctx context.Context, dest ...interface{}) 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 DBService

type DBService struct {
	db.Account
	db.Admin
	db.AdvancedMigration
	db.Application
	db.Basic
	db.Conversation
	db.Domain
	db.Emoji
	db.HeaderFilter
	db.Instance
	db.Interaction
	db.Filter
	db.List
	db.Marker
	db.Media
	db.Mention
	db.Move
	db.Notification
	db.Poll
	db.Relationship
	db.Report
	db.Rule
	db.Search
	db.Session
	db.SinBinStatus
	db.Status
	db.StatusBookmark
	db.StatusFave
	db.Tag
	db.Thread
	db.Timeline
	db.User
	db.Tombstone
	db.WorkerTask
	// contains filtered or unexported fields
}

DBService satisfies the DB interface

func (*DBService) DB

func (dbService *DBService) DB() *bun.DB

GetDB returns the underlying database connection pool. Should only be used in testing + exceptional circumstance.

type UpsertQuery

type UpsertQuery struct {
	// contains filtered or unexported fields
}

UpsertQuery is a wrapper around an insert query that can update if an insert fails. Doesn't implement the full set of Bun query methods, but we can add more if we need them. See https://bun.uptrace.dev/guide/query-insert.html#upsert

func NewUpsert

func NewUpsert(idb bun.IDB) *UpsertQuery

func (*UpsertQuery) Column

func (u *UpsertQuery) Column(columns ...string) *UpsertQuery

Column sets the columns to update if an insert does't happen. If empty, all columns not being used for constraints will be updated. Cannot overlap with Constraint.

func (*UpsertQuery) Constraint

func (u *UpsertQuery) Constraint(constraints ...string) *UpsertQuery

Constraint sets the columns or indexes that are used to check for conflicts. This is required.

func (*UpsertQuery) Exec

func (u *UpsertQuery) Exec(ctx context.Context, dest ...interface{}) (sql.Result, error)

Exec builds a Bun insert query from the upsert query, and executes it.

func (*UpsertQuery) Model

func (u *UpsertQuery) Model(model interface{}) *UpsertQuery

Model sets the model or models to upsert.

func (*UpsertQuery) Scan

func (u *UpsertQuery) Scan(ctx context.Context, dest ...interface{}) error

Scan builds a Bun insert query from the upsert query, and scans it.