The highest tagged major version is v4.

gorm

package module

v0.0.6 Latest Latest Go to latest Published: Sep 27, 2020 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/go-mixins/gorm

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Deadlock(err error) bool
func NotFound(err error) bool
func UniqueViolation(err error) bool
type Backend
type Pagination
- func (p *Pagination) GetPageSize() int
type Paginator
- func (p *Paginator) Paginate(src interface{}, pgn *Pagination) (interface{}, *Pagination)
- func (p *Paginator) Scope(pgn *Pagination) func(*gorm.DB) *gorm.DB

Constants ¶

View Source

const (
	LogDebug logLevel = iota
	LogInfo
)

Log levels (defaults to Debug)

Variables ¶

This section is empty.

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          string
	DBURI           string
	Debug           bool
	LogLevel        logLevel
	Migrate         bool
	MaxIdleConns    int
	MaxOpenConns    int
	ConnMaxLifetime time.Duration
	InitSchema      func(*gorm.DB) error
	// 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) WithContext ¶

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

WithContext creates Backend clone with new context and logger

func (*Backend) WithLogger ¶ added in v0.0.2

func (b *Backend) WithLogger(printer func(...interface{})) *Backend

WithLogger injects log printer func into Backend

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"`
}

Pagination contains pagination fields

func (p *Pagination) GetPageSize() int

GetPageSize returns pagination size

type Paginator ¶

type Paginator struct {
	FieldName     string
	TieBreakField string
	Reverse       bool
	Debug         bool
	IsTime        bool
}

Paginator provides cursor-based paginator

func (*Paginator) Paginate ¶

func (p *Paginator) Paginate(src interface{}, pgn *Pagination) (interface{}, *Pagination)

Paginate query result according to parameter

func (*Paginator) Scope ¶

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

Scope provides proper offset and ordering for cursor db

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL