gormsupport

Documentation

Overview

Package gormsupport provides all the required functions to manage the lifecycle and common operations against our gorm database.

Index

• func IsCheckViolation(err error, constraintName string) bool
• func IsForeignKeyViolation(err error, indexName string) bool
• func IsUniqueViolation(err error, indexName string) bool
• type Lifecycle
  • func (lc Lifecycle) Equal(u convert.Equaler) bool
• type LifecycleHardDelete
  • func (lc LifecycleHardDelete) Equal(u convert.Equaler) bool

Functions

func IsCheckViolation

func IsCheckViolation(err error, constraintName string) bool

IsCheckViolation returns true if the error is a violation of the given check

func IsForeignKeyViolation

func IsForeignKeyViolation(err error, indexName string) bool

IsForeignKeyViolation returns true if the error is a violation of the given foreign key index

func IsUniqueViolation

func IsUniqueViolation(err error, indexName string) bool

IsUniqueViolation returns true if the error is a violation of the given unique index

Types

type Lifecycle

type Lifecycle struct {
	CreatedAt time.Time
	UpdatedAt time.Time
	DeletedAt *time.Time
}

The Lifecycle struct contains all the items from gorm.Model except the ID field, hence we can embed the Lifecycle struct into Models that needs soft delete and alike.

func (Lifecycle) Equal

func (lc Lifecycle) Equal(u convert.Equaler) bool

Equal returns true if two Lifecycle objects are equal; otherwise false is returned.

type LifecycleHardDelete

type LifecycleHardDelete struct {
	CreatedAt time.Time
	UpdatedAt time.Time
}

LifecycleHardDelete struct contains all the items from gorm.Model except the ID and DeletedAt field, hence we can embed the LifecycleHardDelete struct into Models that needs hard delete and alike.

func (LifecycleHardDelete) Equal

func (lc LifecycleHardDelete) Equal(u convert.Equaler) bool

Equal returns true if two LifecycleHardDelete objects are equal; otherwise false is returned.