bun

Documentation

Index

• func New(ctx context.Context) (db.DB, error)
• type Bun
  • func (conn *Bun) ProcessError(err error) db.Error
• type Client
  • func (c *Client) Close(ctx context.Context) db.Error
  • func (c *Client) Create(ctx context.Context, i any) db.Error
  • func (c *Client) DoMigration(ctx context.Context) db.Error
  • func (c *Client) LoadTestData(ctx context.Context) db.Error
  • func (u *Client) ReadUserByEmail(ctx context.Context, email string) (*models.User, db.Error)
  • func (u *Client) ReadUserByID(ctx context.Context, id string) (*models.User, db.Error)

Functions

func New

func New(ctx context.Context) (db.DB, error)

New creates a new bun database client

Types

type Bun

type Bun struct {
	*bun.DB
	// contains filtered or unexported fields
}

Bun represents a bun db connection and it's error handler

func (*Bun) ProcessError

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

ProcessError replaces any known values with our own db.Error types

type Client

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

Client is a DB interface compatible client for Bun

func (*Client) Close

func (c *Client) Close(ctx context.Context) db.Error

Close closes the bun db connection

func (*Client) Create

func (c *Client) Create(ctx context.Context, i any) db.Error

Create inserts an object into the database

func (*Client) DoMigration

func (c *Client) DoMigration(ctx context.Context) db.Error

DoMigration runs schema migrations on the database

func (*Client) LoadTestData

func (c *Client) LoadTestData(ctx context.Context) db.Error

func (*Client) ReadUserByEmail

func (u *Client) ReadUserByEmail(ctx context.Context, email string) (*models.User, db.Error)

func (*Client) ReadUserByID

func (u *Client) ReadUserByID(ctx context.Context, id string) (*models.User, db.Error)