orm

type ChangedValue struct {
	Field     string
	Old       interface{}    `json:",omitempty"`
	New       interface{}    `json:",omitempty"`
	Operation string         // create, update or delete.
	Index     interface{}    `json:",omitempty"` // On delete index is used as ID field.
	Children  []ChangedValue `json:",omitempty"`
}

type Field struct {
	Name        string
	SQLSelect   string
	Permission  Permission
	Information query.Column
	Validator   validator
	NoSQLColumn bool // defines a none db column.
}

type Interface interface {
	Init(Interface) error
	Scope() (Scope, error)

	First(c ...condition.Condition) error
	All(result interface{}, c ...condition.Condition) error
	Count(c ...condition.Condition) (int, error)
	Create() error
	Update() error
	Delete() error

	// Permissions
	Permissions() (p int, fields []string)
	SetPermissions(p int, fields ...string)

	// Defaults
	DefaultBuilder() query.Builder
	DefaultTableName() string
	DefaultDatabaseName() string
	DefaultSoftDelete() SoftDelete
	DefaultCache() (cache.Manager, time.Duration)
	DefaultStrategy() string
	// contains filtered or unexported methods
}

type Join struct {
	Table                string
	ForeignColumnName    string
	ReferencesColumnName string
}

type Mapping struct {
	ForeignKey  Field
	References  Field
	Polymorphic Polymorphic
	Join        Join
}

type Model struct {
	TimeFields
	// contains filtered or unexported fields
}

type Permission struct {
	Read  bool
	Write bool
}

type Polymorphic struct {
	TypeField Field
	Value     string
}

type Relation struct {
	Field string
	Kind  string
	Type  reflect.Type

	NoSQLColumn bool
	Permission  Permission
	Validator   validator

	Mapping Mapping
}

type Scope interface {
	Name(bool) string

	Builder() query.Builder
	FqdnTable() string
	FqdnModel(string) string
	Model() *Model
	Caller() Interface

	Cache() cache.Manager
	SetCache(mgr cache.Manager) error

	SQLFields(permission Permission) []Field
	Fields(permission Permission) []Field
	SQLScanFields(permission Permission) []interface{}
	SQLColumns(permission Permission) []string

	Field(name string) (*Field, error)
	FieldValue(name string) reflect.Value

	SQLRelation(relation string, permission Permission) (Relation, error)
	SQLRelations(permission Permission) []Relation
	Relations(permission Permission) []Relation

	PrimaryKeys() ([]Field, error)
	PrimaryKeysSet() bool

	// helper
	InitRelationByField(field string, setParent bool) (Interface, error)
	InitRelation(relation Interface, field string) error
	SetBackReference(Relation) error
	NewScopeFromType(reflect.Type) (Scope, error)

	// experimental
	Config(...string) config
	SetConfig(*config, ...string)
	SoftDelete() *SoftDelete
	Parent(name string) (*Model, error) // needed for back reference
	SetParent(model *Model)             // needed to avoid loops when called from outside of the orm package (grid).
	IsEmpty(Permission) bool            // needed in create
	IsSelfReferenceLoop(relation Relation) bool
	IsSelfReferencing(relation Relation) bool

	TakeSnapshot(bool)
	Snapshot() Interface

	ChangedValues() []ChangedValue
	AppendChangedValue(c ChangedValue)
	SetChangedValues(c []ChangedValue)
	ChangedValueByFieldName(field string) *ChangedValue
	// contains filtered or unexported methods
}

type SoftDelete struct {
	Field        string // the sql name
	Value        interface{}
	ActiveValues []interface{}
}

type Strategy interface {
	First(scope Scope, c condition.Condition, permission Permission) error
	All(res interface{}, scope Scope, c condition.Condition) error
	Create(scope Scope) error
	Update(scope Scope, c condition.Condition) error
	Delete(scope Scope, c condition.Condition) error

	// reserved for none eager strategies to load relations
	Load(interface{}) Strategy
}

type TimeFields struct {
	CreatedAt *query.NullTime `orm:"permission:w" json:",omitempty"`
	UpdatedAt *query.NullTime `orm:"permission:w" json:",omitempty"`
	DeletedAt *query.NullTime `orm:"permission:w" json:",omitempty"`
}