store

Documentation

Overview

Package store provides utilities when working with a database.

Index

• Variables
• func NewLoggerHook(logger log.Interface, opts ...LoggerHookOption) bun.QueryHook
• func OpenDB(ctx context.Context, databaseURI string) (*sql.DB, error)
• func WrapDriverError(err error) error
• type DriverError
  • func (e *DriverError) Attributes() []any
  • func (e *DriverError) GetError() error
• type LoggerHookOption

Variables

var (
	// ErrUnavailable is an error that indicates an unavailable database.
	ErrUnavailable = errors.DefineUnavailable("database_unavailable", "database unavailable")
	// ErrNotFound is an error that indicates a missing entity.
	ErrNotFound = errors.DefineNotFound("not_found", "no results found")
	// ErrDriver is an error that indicates a driver error.
	ErrDriver = errors.Define("driver", "driver error")
	// ErrIDTaken is returned when an entity can not be created because the ID is already taken.
	ErrIDTaken = errors.DefineAlreadyExists("id_taken", "ID already taken, choose a different one and try again")
	// ErrEUITaken is returned when an entity can not be created because the EUI is already taken.
	ErrEUITaken = errors.DefineAlreadyExists("eui_taken", "EUI already taken")
)

Functions

func NewLoggerHook

func NewLoggerHook(logger log.Interface, opts ...LoggerHookOption) bun.QueryHook

NewLoggerHook returns a new bun.QueryHook that logs queries to the logger.

func OpenDB

func OpenDB(ctx context.Context, databaseURI string) (*sql.DB, error)

OpenDB opens the database connection.

func WrapDriverError

func WrapDriverError(err error) error

WrapDriverError wraps a driver error with the corresponding error definition.

Types

type DriverError

type DriverError struct {
	Code       string
	Message    string
	Detail     string
	Table      string
	Column     string
	Constraint string
}

DriverError encapsulates the PostgreSQL error data.

func (*DriverError) Attributes

func (e *DriverError) Attributes() []any

Attributes gets the DriverError attributes.

func (*DriverError) GetError

func (e *DriverError) GetError() error

GetError gets the corresponding error definition.

type LoggerHookOption

type LoggerHookOption func(*loggerHook)

LoggerHookOption is an option for the LoggerHook.