loggable

README

Loggable

Loggable is used to helps tracking changes and history of your GORM models.

It creates change_logs table in your database and writes to all loggable models when they are changed.

Usage

1. Register plugin using loggable.Register(db)
2. Add loggable.LoggableModel to your GORM model
3. If you want to set user, who makes changes, and place, where it happened, use loggable.SetUserAndFrom("username", "London").

Documentation

Index

• Variables
• func LazyUpdateOption(fields ...string) func(options *options)
• func StringMap(strs []string, fn func(string) string) []string
• func ToLowerFirst(s string) string
• type ChangeLog
• type JSONB
  • func (j JSONB) Equals(j1 JSONB) bool
  • func (j JSONB) IsNull() bool
  • func (j JSONB) MarshalJSON() ([]byte, error)
  • func (j *JSONB) Scan(value interface{}) error
  • func (j *JSONB) UnmarshalJSON(data []byte) error
  • func (j JSONB) Value() (driver.Value, error)
• type LoggableInterface
• type LoggableModel
  • func (m LoggableModel) Enabled() bool
  • func (m LoggableModel) SetEnabled(v bool)
• type LoggablePlugin
  • func Register(db *gorm.DB, opts ...Option) (LoggablePlugin, error)
• type Option

Variables

var ToSnakeCase = toSomeCase("_")

Functions

func LazyUpdateOption

func LazyUpdateOption(fields ...string) func(options *options)

func StringMap

func StringMap(strs []string, fn func(string) string) []string

func ToLowerFirst

func ToLowerFirst(s string) string

Types

type ChangeLog

type ChangeLog struct {
	ID           string    `gorm:"type:uuid;primary_key;"`
	CreatedAt    time.Time `sql:"DEFAULT:current_timestamp"`
	ChangedBy    string    `gorm:"index"`
	ChangedWhere string    `gorm:"index"`
	Action       string
	ObjectID     string `gorm:"index"`
	ObjectType   string `gorm:"index"`
	Object       JSONB  `sql:"type:JSONB"`
}

type JSONB

type JSONB []byte

func (JSONB) Equals

func (j JSONB) Equals(j1 JSONB) bool

func (JSONB) IsNull

func (j JSONB) IsNull() bool

func (JSONB) MarshalJSON

func (j JSONB) MarshalJSON() ([]byte, error)

func (*JSONB) Scan

func (j *JSONB) Scan(value interface{}) error

func (*JSONB) UnmarshalJSON

func (j *JSONB) UnmarshalJSON(data []byte) error

func (JSONB) Value

func (j JSONB) Value() (driver.Value, error)

type LoggableInterface

type LoggableInterface interface {
	SetEnabled(v bool)
	Enabled() bool
}

type LoggableModel

type LoggableModel struct {
	Disabled bool
}

func (LoggableModel) Enabled

func (m LoggableModel) Enabled() bool

func (LoggableModel) SetEnabled

func (m LoggableModel) SetEnabled(v bool)

type LoggablePlugin

type LoggablePlugin interface {
	// Deprecated: Use SetUserAndWhere instead.
	SetUser(user string) *gorm.DB
	// Deprecated: Use SetUserAndWhere instead.
	SetWhere(from string) *gorm.DB
	SetUserAndWhere(user, where string) *gorm.DB
	GetRecords(objectId string) ([]*ChangeLog, error)
}

func Register

func Register(db *gorm.DB, opts ...Option) (LoggablePlugin, error)

type Option

type Option func(options *options)