gormodel

README

gormodel

Maybe some useful toolkits for GORM.

Documentation

Overview

Package gormodel toolkits.

Index

• func BindContext(ctx context.Context, db *gorm.DB) (c context.Context)
• func ExtractContext(ctx context.Context) (db *gorm.DB)
• type Actions
• type Base
  • func (b *Base) Create(ctx context.Context, i interface{}) error
  • func (b *Base) FirstOrCreate(ctx context.Context, i interface{}) error
  • func (b *Base) Get(ctx context.Context, i interface{}) error
  • func (b *Base) GetByID(ctx context.Context, i interface{}, id ...uint) error
  • func (b *Base) Remove(ctx context.Context, i interface{}) error
  • func (b *Base) UpdateAttrs(ctx context.Context, i interface{}, attrs map[string]interface{}) error
  • func (b *Base) UpdateOrCreate(ctx context.Context, i interface{}) error
• type Creator
• type Finder
• type Model
• type Modeler
• type Remover
• type Updater

Examples

• Model

Functions

func BindContext

func BindContext(ctx context.Context, db *gorm.DB) (c context.Context)

BindContext bind db to context.Context.

func ExtractContext

func ExtractContext(ctx context.Context) (db *gorm.DB)

ExtractContext extracts db from context.Context.

Types

type Actions

type Actions interface {
	Creator
	Finder
	Updater
	Remover
}

Actions interface for CRUD

type Base

type Base struct {
}

Base operations helpers.

func (*Base) Create

func (b *Base) Create(ctx context.Context, i interface{}) error

Create action

func (*Base) FirstOrCreate

func (b *Base) FirstOrCreate(ctx context.Context, i interface{}) error

FirstOrCreate create if exists or return first match

func (*Base) Get

func (b *Base) Get(ctx context.Context, i interface{}) error

Get return record with first match.

func (*Base) GetByID

func (b *Base) GetByID(ctx context.Context, i interface{}, id ...uint) error

GetByID return records with given id.

func (*Base) Remove

func (b *Base) Remove(ctx context.Context, i interface{}) error

Remove record

func (*Base) UpdateAttrs

func (b *Base) UpdateAttrs(ctx context.Context, i interface{}, attrs map[string]interface{}) error

UpdateAttrs updates given attrs.

func (*Base) UpdateOrCreate

func (b *Base) UpdateOrCreate(ctx context.Context, i interface{}) error

UpdateOrCreate record

type Creator

type Creator interface {
	Create(context.Context, interface{}) error
	FirstOrCreate(context.Context, interface{}) error
}

Creator for create actions.

type Finder

type Finder interface {
	GetByID(context.Context, interface{}, ...uint) error
	Get(context.Context, interface{}) error
}

Finder for find actions.

type Model

type Model struct {
	ID        uint       `gorm:"PRIMARY_KEY" json:"id"`
	CreatedAt time.Time  `json:"createdAt"`
	UpdatedAt time.Time  `json:"updatedAt"`
	DeletedAt *time.Time `sql:"index" json:"-"`
}

Model likes gorm.Model but with json little camel-case keys.

Example

package main

import (
	"github.com/ipfans/gormodel"
)

func main() {
	type User struct {
		gormodel.Model

		Name string
	}
}

type Modeler

type Modeler interface {
	TableName() string
}

Modeler for table name.

type Remover

type Remover interface {
	Remove(context.Context, interface{}) error
}

Remover for remove actions.

type Updater

type Updater interface {
	UpdateOrCreate(context.Context, interface{}) error
	UpdateAttrs(context.Context, interface{}, map[string]interface{}) error
}

Updater for update actions.