gorm

Documentation

Index

• Constants
• Variables
• func BuildBooleanFilter(field string, filter *query.BooleanFilterOperators) func(db *gorm.DB) *gorm.DB
• func BuildDateFilter(field string, filter *query.DateFilterOperators) func(db *gorm.DB) *gorm.DB
• func BuildDoubleFilter(field string, filter *query.DoubleFilterOperators) func(db *gorm.DB) *gorm.DB
• func BuildFloatFilter(field string, filter *query.FloatFilterOperators) func(db *gorm.DB) *gorm.DB
• func BuildInt32Filter(field string, filter *query.Int32FilterOperators) func(db *gorm.DB) *gorm.DB
• func BuildInt64Filter(field string, filter *query.Int64FilterOperators) func(db *gorm.DB) *gorm.DB
• func BuildNullFilter(field string, filter *query.NullFilterOperators) func(db *gorm.DB) *gorm.DB
• func BuildStringFilter(field string, filter *query.StringFilterOperation) func(db *gorm.DB) *gorm.DB
• func NewConnStrResolver(c *conf.Endpoints, ts common.TenantStore) data.ConnStrResolver
• func NewDbOpener() (sgorm.DbOpener, func())
• func NewDbProvider(cs data.ConnStrResolver, c *sgorm.Config, opener sgorm.DbOpener) sgorm.DbProvider
• func NewGormConfig(databases *conf.Endpoints, name string) *sgorm.Config
• func PageScope(page query.Page) func(db *gorm.DB) *gorm.DB
• func RegisterCallbacks(db *gorm.DB)
• func SortScope(sort query.Sort, d []string) func(db *gorm.DB) *gorm.DB
• func WhereUserId(id interface{}) func(db *gorm.DB) *gorm.DB
• type AuditedModel
  • func (model AuditedModel) GetCreatedBy() *string
  • func (model AuditedModel) GetUpdatedBy() *string
  • func (model *AuditedModel) SetCreatedBy(createdBy interface{})
  • func (model *AuditedModel) SetUpdatedBy(updatedBy interface{})
• type BuildDetailScope
• type BuildFilterScope
• type BuildPageScope
• type BuildSortScope
• type DefaultSorting
• type GetDb
• type Repo
  • func NewRepo[TEntity any, TKey any, TQuery any](dbProvider sgorm.DbProvider, eventbus *eventbus.EventBus, override interface{}) *Repo[TEntity, TKey, TQuery]
  • func (r *Repo[TEntity, TKey, TQuery]) BatchCreate(ctx context.Context, entity []*TEntity, batchSize int) error
  • func (r *Repo[TEntity, TKey, TQuery]) Count(ctx context.Context, query *TQuery) (total int64, filtered int64, err error)
  • func (r *Repo[TEntity, TKey, TQuery]) Create(ctx context.Context, entity *TEntity) error
  • func (r *Repo[TEntity, TKey, TQuery]) Delete(ctx context.Context, id TKey) error
  • func (r *Repo[TEntity, TKey, TQuery]) First(ctx context.Context, query *TQuery) (*TEntity, error)
  • func (r *Repo[TEntity, TKey, TQuery]) Get(ctx context.Context, id TKey) (*TEntity, error)
  • func (r *Repo[TEntity, TKey, TQuery]) List(ctx context.Context, query *TQuery) ([]*TEntity, error)
  • func (r *Repo[TEntity, TKey, TQuery]) Update(ctx context.Context, id TKey, entity *TEntity, p query.Select) error
  • func (r *Repo[TEntity, TKey, TQuery]) Upsert(ctx context.Context, entity *TEntity) error
• type UIDBase
  • func (u *UIDBase) BeforeCreate(tx *gorm.DB) error
• type UpdateAssociation

Constants

const (
	ConcurrentUpdateCode = "CONCURRENT_UPDATE"
)

Variables

var (
	ErrConcurrency = kerrors.Conflict(ConcurrentUpdateCode, "")
)

Functions

func BuildBooleanFilter

func BuildBooleanFilter(field string, filter *query.BooleanFilterOperators) func(db *gorm.DB) *gorm.DB

func BuildDateFilter

func BuildDateFilter(field string, filter *query.DateFilterOperators) func(db *gorm.DB) *gorm.DB

func BuildDoubleFilter

func BuildDoubleFilter(field string, filter *query.DoubleFilterOperators) func(db *gorm.DB) *gorm.DB

func BuildFloatFilter

func BuildFloatFilter(field string, filter *query.FloatFilterOperators) func(db *gorm.DB) *gorm.DB

func BuildInt32Filter

func BuildInt32Filter(field string, filter *query.Int32FilterOperators) func(db *gorm.DB) *gorm.DB

func BuildInt64Filter

func BuildInt64Filter(field string, filter *query.Int64FilterOperators) func(db *gorm.DB) *gorm.DB

func BuildNullFilter

func BuildNullFilter(field string, filter *query.NullFilterOperators) func(db *gorm.DB) *gorm.DB

func BuildStringFilter

func BuildStringFilter(field string, filter *query.StringFilterOperation) func(db *gorm.DB) *gorm.DB

func NewConnStrResolver

func NewConnStrResolver(c *conf.Endpoints, ts common.TenantStore) data.ConnStrResolver

func NewDbOpener

func NewDbOpener() (sgorm.DbOpener, func())

func NewDbProvider

func NewDbProvider(cs data.ConnStrResolver, c *sgorm.Config, opener sgorm.DbOpener) sgorm.DbProvider

func NewGormConfig

func NewGormConfig(databases *conf.Endpoints, name string) *sgorm.Config

NewGormConfig generate config from database endpoint by name.

func PageScope

func PageScope(page query.Page) func(db *gorm.DB) *gorm.DB

func RegisterCallbacks

func RegisterCallbacks(db *gorm.DB)

RegisterCallbacks register callback into GORM DB

func SortScope

func SortScope(sort query.Sort, d []string) func(db *gorm.DB) *gorm.DB

SortScope build sorting by sort and default d

func WhereUserId

func WhereUserId(id interface{}) func(db *gorm.DB) *gorm.DB

WhereUserId append 'user_id' field filter

Types

type AuditedModel

type AuditedModel struct {
	CreatedBy *string
	UpdatedBy *string
	CreatedAt time.Time `gorm:"timestamp"`
	UpdatedAt time.Time `gorm:"timestamp"`
}

AuditedModel make Model Auditable, embed `audited.AuditedModel` into your model as anonymous field to make the model auditable

type User struct {
  gorm.AuditedModel
}

func (AuditedModel) GetCreatedBy

func (model AuditedModel) GetCreatedBy() *string

GetCreatedBy get created by

func (AuditedModel) GetUpdatedBy

func (model AuditedModel) GetUpdatedBy() *string

GetUpdatedBy get updated by

func (*AuditedModel) SetCreatedBy

func (model *AuditedModel) SetCreatedBy(createdBy interface{})

SetCreatedBy set created by

func (*AuditedModel) SetUpdatedBy

func (model *AuditedModel) SetUpdatedBy(updatedBy interface{})

SetUpdatedBy set updated by

type BuildDetailScope

type BuildDetailScope interface {
	BuildDetailScope(withDetail bool) func(db *gorm.DB) *gorm.DB
}

type BuildFilterScope

type BuildFilterScope[TQuery any] interface {
	BuildFilterScope(q *TQuery) func(db *gorm.DB) *gorm.DB
}

type BuildPageScope

type BuildPageScope[TQuery any] interface {
	BuildPageScope(q *TQuery) func(db *gorm.DB) *gorm.DB
}

type BuildSortScope

type BuildSortScope[TQuery any] interface {
	BuildSortScope(q *TQuery) func(db *gorm.DB) *gorm.DB
}

type DefaultSorting

type DefaultSorting interface {
	DefaultSorting() []string
}

type GetDb

type GetDb interface {
	GetDb(ctx context.Context) *gorm.DB
}

type Repo

type Repo[TEntity any, TKey any, TQuery any] struct {
	DbProvider sgorm.DbProvider
	Eventbus   *eventbus.EventBus
	// contains filtered or unexported fields
}

func NewRepo

func NewRepo[TEntity any, TKey any, TQuery any](dbProvider sgorm.DbProvider, eventbus *eventbus.EventBus, override interface{}) *Repo[TEntity, TKey, TQuery]

func (*Repo[TEntity, TKey, TQuery]) BatchCreate

func (r *Repo[TEntity, TKey, TQuery]) BatchCreate(ctx context.Context, entity []*TEntity, batchSize int) error

func (*Repo[TEntity, TKey, TQuery]) Count

func (r *Repo[TEntity, TKey, TQuery]) Count(ctx context.Context, query *TQuery) (total int64, filtered int64, err error)

func (*Repo[TEntity, TKey, TQuery]) Create

func (r *Repo[TEntity, TKey, TQuery]) Create(ctx context.Context, entity *TEntity) error

func (*Repo[TEntity, TKey, TQuery]) Delete

func (r *Repo[TEntity, TKey, TQuery]) Delete(ctx context.Context, id TKey) error

func (*Repo[TEntity, TKey, TQuery]) First

func (r *Repo[TEntity, TKey, TQuery]) First(ctx context.Context, query *TQuery) (*TEntity, error)

func (*Repo[TEntity, TKey, TQuery]) Get

func (r *Repo[TEntity, TKey, TQuery]) Get(ctx context.Context, id TKey) (*TEntity, error)

func (*Repo[TEntity, TKey, TQuery]) List

func (r *Repo[TEntity, TKey, TQuery]) List(ctx context.Context, query *TQuery) ([]*TEntity, error)

func (*Repo[TEntity, TKey, TQuery]) Update

func (r *Repo[TEntity, TKey, TQuery]) Update(ctx context.Context, id TKey, entity *TEntity, p query.Select) error

func (*Repo[TEntity, TKey, TQuery]) Upsert

func (r *Repo[TEntity, TKey, TQuery]) Upsert(ctx context.Context, entity *TEntity) error

type UIDBase

type UIDBase struct {
	ID uuid.UUID `gorm:"type:char(36)" json:"id"`
}

func (*UIDBase) BeforeCreate

func (u *UIDBase) BeforeCreate(tx *gorm.DB) error

type UpdateAssociation

type UpdateAssociation[TEntity any] interface {
	UpdateAssociation(ctx context.Context, entity *TEntity) error
}