Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

models

package

Go to main page

Versions in this module

v0

v0.2.0

Feb 5, 2021

v0.1.9

Feb 1, 2021

Changes in this version

type ConnectionParams

+ Driver string

+ func DBParams() ConnectionParams

+ func (cp ConnectionParams) ConnectionString() string

type FieldInfo

+ DefaultFunc func(Environment) interface{}

type Model

+ func (m *Model) FieldNames() FieldNames

v0.1.8

Jan 20, 2021

v0.1.7

Jan 18, 2021

Changes in this version

+ const ContextSep

+ const DBSerializationMaxRetries

+ const ExprSep

+ var ID = fieldName

+ var Name = fieldName

+ var Registry *modelCollection

+ var Testing bool

+ var Views map[*Model][]string

+ func BootStrap()

+ func BootStrapped() bool

+ func ConvertLimitToInt(limit interface{}) int

+ func CreateM2MRelModelInfo(relModelName, model1, model2, field1, field2 string, mixin bool) (*Model, *Field, *Field)

+ func DBClose()

+ func DBConnect(driver string, params ConnectionParams)

+ func DefaultValue(value interface{}) func(env Environment) interface

+ func ExecuteInNewEnvironment(uid int64, fnct func(Environment)) error

+ func FreeTransientModels()

+ func LoadCSVDataFile(fileName string)

+ func RegisterModelDataWrapper(modelName string, obj interface{})

+ func RegisterRecordSetWrapper(modelName string, obj interface{})

+ func RegisterWorker(wf WorkerFunction)

+ func RunWorkerLoop()

+ func SimulateInNewEnvironment(uid int64, fnct func(Environment)) error

+ func SnakeCaseFieldName(fName string, typ fieldtype.Type) string

+ func StopWorkerLoop()

+ func SyncDatabase()

+ type ClientEvaluatedString string

+ type ColumnData struct

+ ColumnDefault sql.NullString

+ ColumnName string

+ DataType string

+ IsNullable string

+ type Condition struct

+ func (c *Condition) IsEmpty() bool

+ func (c Condition) And() *ConditionStart

+ func (c Condition) AndCond(cond *Condition) *Condition

+ func (c Condition) AndNot() *ConditionStart

+ func (c Condition) AndNotCond(cond *Condition) *Condition

+ func (c Condition) HasField(f *Field) bool

+ func (c Condition) Or() *ConditionStart

+ func (c Condition) OrCond(cond *Condition) *Condition

+ func (c Condition) OrNot() *ConditionStart

+ func (c Condition) OrNotCond(cond *Condition) *Condition

+ func (c Condition) PredicatesWithField(f *Field) []*predicate

+ func (c Condition) Serialize() []interface{}

+ func (c Condition) String() string

+ func (c Condition) Underlying() *Condition

+ type ConditionField struct

+ func (c ConditionField) AddOperator(op operator.Operator, data interface{}) *Condition

+ func (c ConditionField) ChildOf(data interface{}) *Condition

+ func (c ConditionField) Contains(data interface{}) *Condition

+ func (c ConditionField) Equals(data interface{}) *Condition

+ func (c ConditionField) Greater(data interface{}) *Condition

+ func (c ConditionField) GreaterOrEqual(data interface{}) *Condition

+ func (c ConditionField) IContains(data interface{}) *Condition

+ func (c ConditionField) ILike(data interface{}) *Condition

+ func (c ConditionField) In(data interface{}) *Condition

+ func (c ConditionField) IsNotNull() *Condition

+ func (c ConditionField) IsNull() *Condition

+ func (c ConditionField) JSON() string

+ func (c ConditionField) Like(data interface{}) *Condition

+ func (c ConditionField) Lower(data interface{}) *Condition

+ func (c ConditionField) LowerOrEqual(data interface{}) *Condition

+ func (c ConditionField) Name() string

+ func (c ConditionField) NotContains(data interface{}) *Condition

+ func (c ConditionField) NotEquals(data interface{}) *Condition

+ func (c ConditionField) NotIContains(data interface{}) *Condition

+ func (c ConditionField) NotIn(data interface{}) *Condition

+ type ConditionStart struct

+ func (cs ConditionStart) Field(name FieldName) *ConditionField

+ func (cs ConditionStart) FilteredOn(field FieldName, condition *Condition) *Condition

+ type Conditioner interface

+ Underlying func() *Condition

+ type ConnectionParams struct

+ DBName string

+ Host string

+ Password string

+ Port string

+ SSLCA string

+ SSLCert string

+ SSLKey string

+ SSLMode string

+ User string

+ type Cursor struct

+ func (c *Cursor) Execute(query string, args ...interface{}) sql.Result

+ func (c *Cursor) Get(dest interface{}, query string, args ...interface{})

+ func (c *Cursor) Select(dest interface{}, query string, args ...interface{})

+ type DummyField struct

+ func (df DummyField) DeclareField(fc *FieldsCollection, name string) *Field

+ type Environment struct

+ func (env Environment) Context() *types.Context

+ func (env Environment) Cr() *Cursor

+ func (env Environment) DumpCache() string

+ func (env Environment) Pool(modelName string) *RecordCollection

+ func (env Environment) Uid() int64

+ type Field struct

+ func CreateFieldFromStruct(fc *FieldsCollection, fStruct interface{}, name string, ...) *Field

+ func (f *Field) AddContexts(value FieldContexts) *Field

+ func (f *Field) JSON() string

+ func (f *Field) Name() string

+ func (f *Field) SetCompute(value Methoder) *Field

+ func (f *Field) SetConstraint(value Methoder) *Field

+ func (f *Field) SetContexts(value FieldContexts) *Field

+ func (f *Field) SetDefault(value func(Environment) interface{}) *Field

+ func (f *Field) SetDepends(value []string) *Field

+ func (f *Field) SetDigits(value nbutils.Digits) *Field

+ func (f *Field) SetEmbed(value bool) *Field

+ func (f *Field) SetFieldType(value fieldtype.Type) *Field

+ func (f *Field) SetFilter(value Conditioner) *Field

+ func (f *Field) SetGroupOperator(value string) *Field

+ func (f *Field) SetHelp(value string) *Field

+ func (f *Field) SetIndex(value bool) *Field

+ func (f *Field) SetInverse(value Methoder) *Field

+ func (f *Field) SetInvisibleFunc(value func(Environment) (bool, Conditioner)) *Field

+ func (f *Field) SetM2MOurField(value *Field) *Field

+ func (f *Field) SetM2MRelModel(value Modeler) *Field

+ func (f *Field) SetM2MTheirField(value *Field) *Field

+ func (f *Field) SetNoCopy(value bool) *Field

+ func (f *Field) SetOnDelete(value OnDeleteAction) *Field

+ func (f *Field) SetOnchange(value Methoder) *Field

+ func (f *Field) SetOnchangeFilters(value Methoder) *Field

+ func (f *Field) SetOnchangeWarning(value Methoder) *Field

+ func (f *Field) SetProperty(property string, value interface{})

+ func (f *Field) SetReadOnly(value bool) *Field

+ func (f *Field) SetReadOnlyFunc(value func(Environment) (bool, Conditioner)) *Field

+ func (f *Field) SetRelated(value string) *Field

+ func (f *Field) SetRelationModel(value Modeler) *Field

+ func (f *Field) SetRequired(value bool) *Field

+ func (f *Field) SetRequiredFunc(value func(Environment) (bool, Conditioner)) *Field

+ func (f *Field) SetReverseFK(value string) *Field

+ func (f *Field) SetSelection(value types.Selection) *Field

+ func (f *Field) SetSelectionFunc(value func() types.Selection) *Field

+ func (f *Field) SetSize(value int) *Field

+ func (f *Field) SetStored(value bool) *Field

+ func (f *Field) SetString(value string) *Field

+ func (f *Field) SetTranslate(value bool) *Field

+ func (f *Field) SetUnique(value bool) *Field

+ func (f *Field) UpdateSelection(value types.Selection) *Field

+ type FieldContexts map[string]func(RecordSet) string

+ type FieldDefinition interface

+ DeclareField func(*FieldsCollection, string) *Field

+ type FieldInfo struct

+ ChangeDefault bool

+ CompanyDependent bool

+ Depends []string

+ Domain interface{}

+ GoType reflect.Type

+ Help string

+ Index bool

+ InvisibleFunc func(Environment) (bool, Conditioner)

+ JSON string

+ Manual bool

+ Name string

+ OnChange bool

+ ReadOnly bool

+ ReadOnlyFunc func(Environment) (bool, Conditioner)

+ Relation string

+ Required bool

+ RequiredFunc func(Environment) (bool, Conditioner)

+ ReverseFK string

+ Searchable bool

+ Selection types.Selection

+ Sortable bool

+ Store bool

+ String string

+ Translate bool

+ Type fieldtype.Type

+ Views map[string]interface{}

+ type FieldMap map[string]interface

+ func (fm *FieldMap) Delete(field FieldName)

+ func (fm *FieldMap) MergeWith(other FieldMap, model *Model)

+ func (fm *FieldMap) RemovePK()

+ func (fm *FieldMap) RemovePKIfZero()

+ func (fm *FieldMap) Set(field FieldName, value interface{})

+ func (fm FieldMap) Copy() FieldMap

+ func (fm FieldMap) FieldNames(model *Model) FieldNames

+ func (fm FieldMap) Get(field FieldName) (interface{}, bool)

+ func (fm FieldMap) Keys() (res []string)

+ func (fm FieldMap) MustGet(field FieldName) interface{}

+ func (fm FieldMap) OrderedKeys() []string

+ func (fm FieldMap) Underlying() FieldMap

+ func (fm FieldMap) Values() (res []interface{})

+ type FieldMapper interface

+ Underlying func() FieldMap

+ type FieldName interface

+ JSON func() string

+ Name func() string

+ func NewFieldName(name, json string) FieldName

+ type FieldNames []FieldName

+ func (f *FieldNames) UnmarshalJSON(data []byte) error

+ func (f FieldNames) JSON() []string

+ func (f FieldNames) Len() int

+ func (f FieldNames) Less(i, j int) bool

+ func (f FieldNames) Names() []string

+ func (f FieldNames) Swap(i, j int)

+ type FieldsCollection struct

+ func (fc *FieldsCollection) Get(name string) (fi *Field, ok bool)

+ func (fc *FieldsCollection) Model() *Model

+ func (fc *FieldsCollection) MustGet(name string) *Field

+ type FieldsGetArgs struct

+ Fields FieldNames

+ type GroupAggregateRow struct

+ Condition *Condition

+ Count int

+ Values *ModelData

+ type Method struct

+ func (m *Method) AllowGroup(group *security.Group, callers ...Methoder) *Method

+ func (m *Method) Call(rc *RecordCollection, params ...interface{}) interface{}

+ func (m *Method) CallMulti(rc *RecordCollection, params ...interface{}) []interface{}

+ func (m *Method) Extend(fnct interface{}) *Method

+ func (m *Method) MethodType() reflect.Type

+ func (m *Method) Name() string

+ func (m *Method) RevokeGroup(group *security.Group) *Method

+ func (m *Method) Underlying() *Method

+ type Methoder interface

+ Underlying func() *Method

+ type MethodsCollection struct

+ func (mc *MethodsCollection) AllowAllToGroup(group *security.Group)

+ func (mc *MethodsCollection) Get(methodName string) (*Method, bool)

+ func (mc *MethodsCollection) MustGet(methodName string) *Method

+ func (mc *MethodsCollection) RevokeAllFromGroup(group *security.Group)

+ type Model struct

+ func CreateModel(name string, options Option) *Model

+ func NewManualModel(name string) *Model

+ func NewMixinModel(name string) *Model

+ func NewModel(name string) *Model

+ func NewTransientModel(name string) *Model

+ func (m *Model) AddEmptyMethod(methodName string) *Method

+ func (m *Model) AddFields(fields map[string]FieldDefinition)

+ func (m *Model) AddRecordRule(rule *RecordRule)

+ func (m *Model) AddSQLConstraint(name, sql, errorString string)

+ func (m *Model) Browse(env Environment, ids []int64) *RecordCollection

+ func (m *Model) BrowseOne(env Environment, id int64) *RecordCollection

+ func (m *Model) Create(env Environment, data interface{}) *RecordCollection

+ func (m *Model) Field(name FieldName) *ConditionField

+ func (m *Model) FieldName(name string) FieldName

+ func (m *Model) Fields() *FieldsCollection

+ func (m *Model) FieldsGet(fields ...FieldName) map[string]*FieldInfo

+ func (m *Model) FilteredOn(field FieldName, condition *Condition) *Condition

+ func (m *Model) InheritModel(mixInModel Modeler)

+ func (m *Model) IsM2MLink() bool

+ func (m *Model) IsManual() bool

+ func (m *Model) IsMixin() bool

+ func (m *Model) IsTransient() bool

+ func (m *Model) JSONizeFieldName(fieldName string) string

+ func (m *Model) Methods() *MethodsCollection

+ func (m *Model) Name() string

+ func (m *Model) NewMethod(methodName string, fnct interface{}) *Method

+ func (m *Model) RemoveRecordRule(name string)

+ func (m *Model) RemoveSQLConstraint(name string)

+ func (m *Model) Search(env Environment, cond Conditioner) *RecordCollection

+ func (m *Model) SetDefaultOrder(orders ...string)

+ func (m *Model) TableName() string

+ func (m *Model) Underlying() *Model

+ type ModelData struct

+ Model *Model

+ ToCreate map[string][]*ModelData

+ func NewModelData(model Modeler, fm ...FieldMap) *ModelData

+ func NewModelDataFromRS(rs RecordSet, fm ...FieldMap) *ModelData

+ func (md *ModelData) Copy() *ModelData

+ func (md *ModelData) Create(field FieldName, related *ModelData) *ModelData

+ func (md *ModelData) FieldNames() FieldNames

+ func (md *ModelData) Get(field FieldName) interface{}

+ func (md *ModelData) Has(field FieldName) bool

+ func (md *ModelData) MarshalJSON() ([]byte, error)

+ func (md *ModelData) MergeWith(other *ModelData)

+ func (md *ModelData) Scan(src interface{}) error

+ func (md *ModelData) Set(field FieldName, value interface{}) *ModelData

+ func (md *ModelData) Underlying() *ModelData

+ func (md *ModelData) Unset(field FieldName) *ModelData

+ func (md ModelData) Wrap() interface{}

+ type Modeler interface

+ Underlying func() *Model

+ type OnDeleteAction string

+ const Cascade

+ const Restrict

+ const SetNull

+ type OnchangeParams struct

+ Fields FieldNames

+ Onchange map[string]string

+ Values RecordData

+ type OnchangeResult struct

+ Filters map[FieldName]Conditioner

+ Value RecordData

+ Warning string

+ type Option int

+ const ContextsModel

+ const ManualModel

+ const Many2ManyLinkModel

+ const MixinModel

+ const SystemModel

+ const TransientModel

+ type Query struct

+ type RecordCollection struct

+ func InvalidRecordCollection(modelName string) *RecordCollection

+ func (rc *RecordCollection) Aggregates(fieldNames ...FieldName) []GroupAggregateRow

+ func (rc *RecordCollection) All() []*ModelData

+ func (rc *RecordCollection) Call(methName string, args ...interface{}) interface{}

+ func (rc *RecordCollection) CallMulti(methName string, args ...interface{}) []interface{}

+ func (rc *RecordCollection) CartesianProduct(records ...RecordSet) []*RecordCollection

+ func (rc *RecordCollection) CheckConstraints()

+ func (rc *RecordCollection) CheckExecutionPermission(method *Method, dontPanic ...bool) bool

+ func (rc *RecordCollection) Collection() *RecordCollection

+ func (rc *RecordCollection) Condition() *Condition

+ func (rc *RecordCollection) EnsureOne()

+ func (rc *RecordCollection) Env() Environment

+ func (rc *RecordCollection) Equals(other RecordSet) bool

+ func (rc *RecordCollection) Fetch() *RecordCollection

+ func (rc *RecordCollection) Filtered(test func(rs RecordSet) bool) *RecordCollection

+ func (rc *RecordCollection) First() *ModelData

+ func (rc *RecordCollection) ForceLoad(fieldNames ...FieldName) *RecordCollection

+ func (rc *RecordCollection) Get(fieldName FieldName) interface{}

+ func (rc *RecordCollection) GetRecord(externalID string) *RecordCollection

+ func (rc *RecordCollection) GroupBy(fields ...FieldName) *RecordCollection

+ func (rc *RecordCollection) Ids() []int64

+ func (rc *RecordCollection) Intersect(other RecordSet) *RecordCollection

+ func (rc *RecordCollection) InvalidateCache()

+ func (rc *RecordCollection) IsEmpty() bool

+ func (rc *RecordCollection) IsNotEmpty() bool

+ func (rc *RecordCollection) IsValid() bool

+ func (rc *RecordCollection) Len() int

+ func (rc *RecordCollection) Limit(limit int) *RecordCollection

+ func (rc *RecordCollection) Load(fields ...FieldName) *RecordCollection

+ func (rc *RecordCollection) MethodType(methName string) reflect.Type

+ func (rc *RecordCollection) Model() *Model

+ func (rc *RecordCollection) ModelName() string

+ func (rc *RecordCollection) Offset(offset int) *RecordCollection

+ func (rc *RecordCollection) OrderBy(exprs ...string) *RecordCollection

+ func (rc *RecordCollection) Records() []*RecordCollection

+ func (rc *RecordCollection) SQLFromCondition(c *Condition) (string, SQLParams)

+ func (rc *RecordCollection) Scan(src interface{}) error

+ func (rc *RecordCollection) Search(cond *Condition) *RecordCollection

+ func (rc *RecordCollection) SearchAll() *RecordCollection

+ func (rc *RecordCollection) SearchCount() int

+ func (rc *RecordCollection) Set(fieldName FieldName, value interface{})

+ func (rc *RecordCollection) Sorted(less func(rs1 RecordSet, rs2 RecordSet) bool) *RecordCollection

+ func (rc *RecordCollection) SortedByField(name FieldName, reverse bool) *RecordCollection

+ func (rc *RecordCollection) SortedDefault() *RecordCollection

+ func (rc *RecordCollection) String() string

+ func (rc *RecordCollection) Subtract(other RecordSet) *RecordCollection

+ func (rc *RecordCollection) Sudo(userId ...int64) *RecordCollection

+ func (rc *RecordCollection) Super() *RecordCollection

+ func (rc *RecordCollection) T(src string, args ...interface{}) string

+ func (rc *RecordCollection) Union(other RecordSet) *RecordCollection

+ func (rc *RecordCollection) WithContext(key string, value interface{}) *RecordCollection

+ func (rc *RecordCollection) WithEnv(env Environment) *RecordCollection

+ func (rc *RecordCollection) WithNewContext(context *types.Context) *RecordCollection

+ func (rc *RecordCollection) Wrap(modelName ...string) interface{}

+ type RecordData interface

+ Underlying func() *ModelData

+ type RecordRef struct

+ ID int64

+ ModelName string

+ type RecordRule struct

+ Condition *Condition

+ Global bool

+ Group *security.Group

+ Name string

+ Perms security.Permission

+ type RecordSet interface

+ Call func(string, ...interface{}) interface{}

+ Collection func() *RecordCollection

+ EnsureOne func()

+ Env func() Environment

+ Get func(FieldName) interface{}

+ Ids func() []int64

+ IsEmpty func() bool

+ IsNotEmpty func() bool

+ IsValid func() bool

+ Len func() int

+ ModelName func() string

+ Set func(FieldName, interface{})

+ T func(string, ...interface{}) string

+ type SQLParams []interface

+ func (p SQLParams) Extend(p2 SQLParams) SQLParams

+ type Sequence struct

+ Increment int64

+ JSON string

+ Start int64

+ func CreateSequence(name string, increment, start int64) *Sequence

+ func (s *Sequence) Alter(increment, restart int64)

+ func (s *Sequence) Drop()

+ func (s *Sequence) NextValue() int64

+ type WorkerFunction interface

+ LoopPeriod func() time.Duration

+ Run func()

+ func NewWorkerFunction(fnct func(), period time.Duration) WorkerFunction