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
- Register plugin using
loggable.Register(db).
plugin, err := Register(database) // database is a *gorm.DB
if err != nil {
panic(err)
}
- Add (embed)
loggable.LoggableModelto your GORM model.
type User struct{
Id uint
CreatedAt time.Time
// some other stuff...
loggable.LoggableModel
}
- Changes after calling Create, Save, Update, Delete will be tracked.
Customization
You may add additional fields to change logs, that should be saved.
First, embed loggable.LoggableModel to your model wrapper or directly to GORM model.
type CreatedByLog struct {
// Public field will be catches by GORM and will be saved to main table.
CreatedBy string
// Hided field because we do not want to write this to main table,
// only to change_logs.
createdByPass string
loggable.LoggableModel
}
After that, shadow LoggableModel's Meta() method by writing your realization, that should return structure with your information.
type CreatedByLog struct {
CreatedBy string
createdByPass string
loggable.LoggableModel
}
func (m CreatedByLog) Meta() interface{} {
return struct { // You may define special type for this purposes, here we use unnamed one.
CreatedBy string
CreatedByPass string // CreatedByPass is a public because we want to track this field.
}{
CreatedBy: m.CreatedBy,
CreatedByPass: m.createdByPass,
}
}
Options
LazyUpdate
Option LazyUpdate allows save changes only if they big enough to be saved.
Plugin compares the last saved object and the new one, but ignores changes was made in fields from provided list.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ToSnakeCase = toSomeCase("_")
Functions ¶
func ToLowerFirst ¶ added in v1.3.0
Types ¶
type ChangeLog ¶
type ChangeLog struct {
ID string `gorm:"type:uuid;primary_key;"`
CreatedAt time.Time `sql:"DEFAULT:current_timestamp"`
Action string
ObjectID string `gorm:"index"`
ObjectType string `gorm:"index"`
RawObject JSONB `sql:"type:JSONB"`
RawMeta JSONB `sql:"type:JSONB"`
Object interface{} `sql:"-"`
Meta interface{} `sql:"-"`
}
ChangeLog is a main entity, which used to log changes.
type Interface ¶
type Interface interface {
// Meta should return structure, that can be converted to json.
Meta() interface{}
// enable/disable loggable
Enable(v bool)
// contains filtered or unexported methods
}
Interface is used to get metadata from your models.
type LoggableModel ¶
type LoggableModel struct {
Disabled bool `sql:"-"`
}
LoggableModel is a root structure, which implement Interface. Embed LoggableModel to your model so that Plugin starts tracking changes.
func (LoggableModel) Enable ¶
func (l LoggableModel) Enable(v bool)
func (LoggableModel) Meta ¶
func (LoggableModel) Meta() interface{}
type Option ¶ added in v1.3.0
type Option func(options *options)
func LazyUpdate ¶
func RegMetaType ¶
func RegObjectType ¶
type Plugin ¶
type Plugin struct {
// contains filtered or unexported fields
}
Source Files