gorm

Documentation

Index

• func Deadlock(err error) bool
• func NotFound(err error) bool
• func UniqueViolation(err error) bool
• type Backend
  • func (b *Backend) Begin() *Backend
  • func (b *Backend) Close() error
  • func (b *Backend) Connect(migrations ...*gormigrate.Migration) error
  • func (b *Backend) Context() context.Context
  • func (b *Backend) End(rErr error) error
  • func (b *Backend) Error(ctx context.Context, f string, v ...interface{})
  • func (b *Backend) Info(ctx context.Context, f string, v ...interface{})
  • func (b *Backend) LogMode(l logger.LogLevel) logger.Interface
  • func (b *Backend) Trace(ctx context.Context, begin time.Time, fc func() (string, int64), err error)
  • func (b *Backend) Warn(ctx context.Context, f string, v ...interface{})
  • func (b *Backend) WithContext(ctx context.Context) *Backend
  • func (b *Backend) WithDebug() *Backend
• type Pagination
  • func (p *Pagination) GetPageSize() int
  • func (p Pagination) WithTable(tableName string) Pagination
• type Paginator
  • func NewPaginator[A any]() (*Paginator[*A], error)
  • func (p *Paginator[A]) Paginate(src []A, pgn *Pagination) ([]A, *Pagination)
  • func (p *Paginator[A]) Scope(pgn *Pagination) func(*gorm.DB) *gorm.DB

Functions

func Deadlock

func Deadlock(err error) bool

Deadlock is true when deadlock was detected

func NotFound

func NotFound(err error) bool

NotFound is true when there was no appropriate record

func UniqueViolation

func UniqueViolation(err error) bool

UniqueViolation is true when database unique index is violated

Types

type Backend

type Backend struct {
	DB              *gorm.DB
	Driver          gorm.Dialector
	Config          *gorm.Config
	Debug           bool
	Migrate         bool
	MaxIdleConns    int
	MaxOpenConns    int
	ConnMaxLifetime time.Duration
	InitSchema      func(*gorm.DB) error
	Logger          *slog.Logger
	// contains filtered or unexported fields
}

Backend implements generic database backend

func (*Backend) Begin

func (b *Backend) Begin() *Backend

func (*Backend) Close

func (b *Backend) Close() error

Close DB connection

func (*Backend) Connect

func (b *Backend) Connect(migrations ...*gormigrate.Migration) error

Connect sets up the backend and applies migrations if Migrate flag is set to true. InitSchema func if set, is used to create initial schema.

func (*Backend) Context

func (b *Backend) Context() context.Context

Context returns context associated with Backend

func (*Backend) End

func (b *Backend) End(rErr error) error

func (*Backend) Error

func (b *Backend) Error(ctx context.Context, f string, v ...interface{})

func (*Backend) Info

func (b *Backend) Info(ctx context.Context, f string, v ...interface{})

func (*Backend) LogMode

func (b *Backend) LogMode(l logger.LogLevel) logger.Interface

func (*Backend) Trace

func (b *Backend) Trace(ctx context.Context, begin time.Time, fc func() (string, int64), err error)

func (*Backend) Warn

func (b *Backend) Warn(ctx context.Context, f string, v ...interface{})

func (*Backend) WithContext

func (b *Backend) WithContext(ctx context.Context) *Backend

WithContext creates Backend clone with new context and logger

func (*Backend) WithDebug

func (b *Backend) WithDebug() *Backend

type Pagination

type Pagination struct {
	PageSize      int    `json:"page_size"`
	NextPageToken string `json:"next_page_token"`
	ThisPageToken string `json:"this_page_token"`
	PrevPageToken string `json:"prev_page_token"`
	// contains filtered or unexported fields
}

Pagination contains pagination fields

func (*Pagination) GetPageSize

func (p *Pagination) GetPageSize() int

GetPageSize returns pagination size

func (Pagination) WithTable

func (p Pagination) WithTable(tableName string) Pagination

type Paginator

type Paginator[A any] struct {
	FieldName     string
	TieBreakField string
	Reverse       bool
	Debug         bool
	IsTime        bool
}

Paginator provides cursor-based paginator

func NewPaginator

func NewPaginator[A any]() (*Paginator[*A], error)

func (*Paginator[A]) Paginate

func (p *Paginator[A]) Paginate(src []A, pgn *Pagination) ([]A, *Pagination)

Paginate query result according to parameter

func (*Paginator[A]) Scope

func (p *Paginator[A]) Scope(pgn *Pagination) func(*gorm.DB) *gorm.DB

Scope provides proper offset and ordering for cursor db