genepoint_service/app/model/bank_arrange_detail/bank_arrange_detail_model.go

// ==========================================================================
// This is auto-generated by gf cli tool. DO NOT EDIT THIS FILE MANUALLY.
// ==========================================================================

package bank_arrange_detail

import (
	"context"
	"database/sql"
	"github.com/gogf/gf/database/gdb"
	"github.com/gogf/gf/frame/g"
	"github.com/gogf/gf/frame/gmvc"
	"time"
)

// arModel is a active record design model for table bank_arrange_detail operations.
type arModel struct {
	gmvc.M
}

var (
	// Table is the table name of bank_arrange_detail.
	Table = "bank_arrange_detail"
	// Model is the model object of bank_arrange_detail.
	Model = &arModel{g.DB("default").Model(Table).Safe()}
	// Columns defines and stores column names for table bank_arrange_detail.
	Columns = struct {
		Id                string //                                                                                                                                                              
        ParentId          string // 库内整理主单ID                                                                                                                                               
        BoxId             string // 冻存盒表bank_box的Id                                                                                                                                         
        SampleId          string // 样本表bank_sample的id                                                                                                                                        
        BarCode           string // 唯一码，ArrangeType=1时，该字段为盒子编码，ArrangeType=2时，该字段为样本编码                                                                                 
        TaskStatus        string // 任务执行状态(与main表一致) 4. 执行失败 5. 执行成功;7 驳回                                                                                                    
        EquipmentId       string // 容器ID                                                                                                                                                       
        ShelfId           string // 冻存架Id                                                                                                                                                     
        Position          string // 所处位置；格式(x;y)x代表第几列 Y代表第几行，positionInfo中需要将Y转为对应字母值，再拼接X;ArrangeType=1时，表示位于架子上位置，为2时表示位于盒内的位置        
        PositionInfo      string // 列表中显示的位置信息，ArrangeType=1时，表示（容器+架子+position）例如：容器1-A1-A2,ArrangeType=2时，表示（容器+层+盒+position），例如：容器1-A1-A1-A2        
        LastBoxId         string // 整理前盒子Id，ArrangeType=2时，该字段不为空，表示样本再整理前存放的盒子id                                                                                    
        LastShelfId       string // 整理前冻存架Id                                                                                                                                               
        LastPosition      string // 整理前所处位置；格式(x;y)x代表第几列 Y代表第几行，positionInfo中需要将Y转为对应字母值，再拼接X;ArrangeType=1时，表示位于架子上位置，为2时表示位于盒内的位置  
        LastPositionInfo  string // 列表中显示的整理前的位置信息，ArrangeType=1时，表示（容器+分区+position）,ArrangeType=2时，表示（容器+分区+盒位置+position）                                 
        IsLocked          string // 是否显示锁的标志（入库，出库审批过程中显示锁）                                                                                                               
        CancelId          string // 撤销人Id                                                                                                                                                     
        CancelBy          string // 撤销人                                                                                                                                                       
        Remark            string // 备注                                                                                                                                                         
        DetailStatus      string // 状态0：申请；2：已审核;1 提交待审核                                                                                                                          
        CreateOn          string //                                                                                                                                                              
        CreateUserId      string //                                                                                                                                                              
        CreateBy          string //                                                                                                                                                              
        ModifiedOn        string //                                                                                                                                                              
        ModifiedUserId    string //                                                                                                                                                              
        ModifiedBy        string //                                                                                                                                                              
        ArrangeType       string // 类型，1:盒子，2:样本                                                                                                                                         
        Reason            string // 原因明细，ID是字典明细
	}{
		Id:               "Id",                
        ParentId:         "ParentId",          
        BoxId:            "BoxId",             
        SampleId:         "SampleId",          
        BarCode:          "BarCode",           
        TaskStatus:       "TaskStatus",        
        EquipmentId:      "EquipmentId",       
        ShelfId:          "ShelfId",           
        Position:         "Position",          
        PositionInfo:     "PositionInfo",      
        LastBoxId:        "LastBoxId",         
        LastShelfId:      "LastShelfId",       
        LastPosition:     "LastPosition",      
        LastPositionInfo: "LastPositionInfo",  
        IsLocked:         "IsLocked",          
        CancelId:         "CancelId",          
        CancelBy:         "CancelBy",          
        Remark:           "Remark",            
        DetailStatus:     "DetailStatus",      
        CreateOn:         "CreateOn",          
        CreateUserId:     "CreateUserId",      
        CreateBy:         "CreateBy",          
        ModifiedOn:       "ModifiedOn",        
        ModifiedUserId:   "ModifiedUserId",    
        ModifiedBy:       "ModifiedBy",        
        ArrangeType:      "ArrangeType",       
        Reason:           "Reason",
	}
)

// Ctx is a chaining function, which creates and returns a new DB that is a shallow copy
// of current DB object and with given context in it.
// Note that this returned DB object can be used only once, so do not assign it to
// a global or package variable for long using.
func (m *arModel) Ctx(ctx context.Context) *arModel {
	return &arModel{m.M.Ctx(ctx)}
}

// As sets an alias name for current table.
func (m *arModel) As(as string) *arModel {
	return &arModel{m.M.As(as)}
}

// TX sets the transaction for current operation.
func (m *arModel) TX(tx *gdb.TX) *arModel {
	return &arModel{m.M.TX(tx)}
}

// Master marks the following operation on master node.
func (m *arModel) Master() *arModel {
	return &arModel{m.M.Master()}
}

// Slave marks the following operation on slave node.
// Note that it makes sense only if there's any slave node configured.
func (m *arModel) Slave() *arModel {
	return &arModel{m.M.Slave()}
}

// LeftJoin does "LEFT JOIN ... ON ..." statement on the model.
// The parameter <table> can be joined table and its joined condition,
// and also with its alias name, like:
// Table("user").LeftJoin("user_detail", "user_detail.uid=user.uid")
// Table("user", "u").LeftJoin("user_detail", "ud", "ud.uid=u.uid")
func (m *arModel) LeftJoin(table ...string) *arModel {
	return &arModel{m.M.LeftJoin(table ...)}
}

// RightJoin does "RIGHT JOIN ... ON ..." statement on the model.
// The parameter <table> can be joined table and its joined condition,
// and also with its alias name, like:
// Table("user").RightJoin("user_detail", "user_detail.uid=user.uid")
// Table("user", "u").RightJoin("user_detail", "ud", "ud.uid=u.uid")
func (m *arModel) RightJoin(table ...string) *arModel {
	return &arModel{m.M.RightJoin(table ...)}
}

// InnerJoin does "INNER JOIN ... ON ..." statement on the model.
// The parameter <table> can be joined table and its joined condition,
// and also with its alias name, like:
// Table("user").InnerJoin("user_detail", "user_detail.uid=user.uid")
// Table("user", "u").InnerJoin("user_detail", "ud", "ud.uid=u.uid")
func (m *arModel) InnerJoin(table ...string) *arModel {
	return &arModel{m.M.InnerJoin(table ...)}
}

// Fields sets the operation fields of the model, multiple fields joined using char ','.
func (m *arModel) Fields(fieldNamesOrMapStruct ...interface{}) *arModel {
	return &arModel{m.M.Fields(fieldNamesOrMapStruct...)}
}

// FieldsEx sets the excluded operation fields of the model, multiple fields joined using char ','.
func (m *arModel) FieldsEx(fieldNamesOrMapStruct ...interface{}) *arModel {
	return &arModel{m.M.FieldsEx(fieldNamesOrMapStruct...)}
}

// Option sets the extra operation option for the model.
func (m *arModel) Option(option int) *arModel {
	return &arModel{m.M.Option(option)}
}

// OmitEmpty sets OPTION_OMITEMPTY option for the model, which automatically filers
// the data and where attributes for empty values.
func (m *arModel) OmitEmpty() *arModel {
	return &arModel{m.M.OmitEmpty()}
}

// Filter marks filtering the fields which does not exist in the fields of the operated table.
func (m *arModel) Filter() *arModel {
	return &arModel{m.M.Filter()}
}

// Where sets the condition statement for the model. The parameter <where> can be type of
// string/map/gmap/slice/struct/*struct, etc. Note that, if it's called more than one times,
// multiple conditions will be joined into where statement using "AND".
// Eg:
// Where("uid=10000")
// Where("uid", 10000)
// Where("money>? AND name like ?", 99999, "vip_%")
// Where("uid", 1).Where("name", "john")
// Where("status IN (?)", g.Slice{1,2,3})
// Where("age IN(?,?)", 18, 50)
// Where(User{ Id : 1, UserName : "john"})
func (m *arModel) Where(where interface{}, args ...interface{}) *arModel {
	return &arModel{m.M.Where(where, args...)}
}

// WherePri does the same logic as Model.Where except that if the parameter <where>
// is a single condition like int/string/float/slice, it treats the condition as the primary
// key value. That is, if primary key is "id" and given <where> parameter as "123", the
// WherePri function treats the condition as "id=123", but Model.Where treats the condition
// as string "123".
func (m *arModel) WherePri(where interface{}, args ...interface{}) *arModel {
	return &arModel{m.M.WherePri(where, args...)}
}

// And adds "AND" condition to the where statement.
func (m *arModel) And(where interface{}, args ...interface{}) *arModel {
	return &arModel{m.M.And(where, args...)}
}

// Or adds "OR" condition to the where statement.
func (m *arModel) Or(where interface{}, args ...interface{}) *arModel {
	return &arModel{m.M.Or(where, args...)}
}

// Group sets the "GROUP BY" statement for the model.
func (m *arModel) Group(groupBy string) *arModel {
	return &arModel{m.M.Group(groupBy)}
}

// Order sets the "ORDER BY" statement for the model.
func (m *arModel) Order(orderBy ...string) *arModel {
	return &arModel{m.M.Order(orderBy...)}
}

// Limit sets the "LIMIT" statement for the model.
// The parameter <limit> can be either one or two number, if passed two number is passed,
// it then sets "LIMIT limit[0],limit[1]" statement for the model, or else it sets "LIMIT limit[0]"
// statement.
func (m *arModel) Limit(limit ...int) *arModel {
	return &arModel{m.M.Limit(limit...)}
}

// Offset sets the "OFFSET" statement for the model.
// It only makes sense for some databases like SQLServer, PostgreSQL, etc.
func (m *arModel) Offset(offset int) *arModel {
	return &arModel{m.M.Offset(offset)}
}

// Page sets the paging number for the model.
// The parameter <page> is started from 1 for paging.
// Note that, it differs that the Limit function start from 0 for "LIMIT" statement.
func (m *arModel) Page(page, limit int) *arModel {
	return &arModel{m.M.Page(page, limit)}
}

// Batch sets the batch operation number for the model.
func (m *arModel) Batch(batch int) *arModel {
	return &arModel{m.M.Batch(batch)}
}

// Cache sets the cache feature for the model. It caches the result of the sql, which means
// if there's another same sql request, it just reads and returns the result from cache, it
// but not committed and executed into the database.
//
// If the parameter <duration> < 0, which means it clear the cache with given <name>.
// If the parameter <duration> = 0, which means it never expires.
// If the parameter <duration> > 0, which means it expires after <duration>.
//
// The optional parameter <name> is used to bind a name to the cache, which means you can later
// control the cache like changing the <duration> or clearing the cache with specified <name>.
//
// Note that, the cache feature is disabled if the model is operating on a transaction.
func (m *arModel) Cache(duration time.Duration, name ...string) *arModel {
	return &arModel{m.M.Cache(duration, name...)}
}

// Data sets the operation data for the model.
// The parameter <data> can be type of string/map/gmap/slice/struct/*struct, etc.
// Eg:
// Data("uid=10000")
// Data("uid", 10000)
// Data(g.Map{"uid": 10000, "name":"john"})
// Data(g.Slice{g.Map{"uid": 10000, "name":"john"}, g.Map{"uid": 20000, "name":"smith"})
func (m *arModel) Data(data ...interface{}) *arModel {
	return &arModel{m.M.Data(data...)}
}

// All does "SELECT FROM ..." statement for the model.
// It retrieves the records from table and returns the result as []*Entity.
// It returns nil if there's no record retrieved with the given conditions from table.
//
// The optional parameter <where> is the same as the parameter of Model.Where function,
// see Model.Where.
func (m *arModel) All(where ...interface{}) ([]*Entity, error) {
	all, err := m.M.All(where...)
	if err != nil {
		return nil, err
	}
	var entities []*Entity
	if err = all.Structs(&entities); err != nil && err != sql.ErrNoRows {
		return nil, err
	}
	return entities, nil
}

// One retrieves one record from table and returns the result as *Entity.
// It returns nil if there's no record retrieved with the given conditions from table.
//
// The optional parameter <where> is the same as the parameter of Model.Where function,
// see Model.Where.
func (m *arModel) One(where ...interface{}) (*Entity, error) {
	one, err := m.M.One(where...)
	if err != nil {
		return nil, err
	}
	var entity *Entity
	if err = one.Struct(&entity); err != nil && err != sql.ErrNoRows {
		return nil, err
	}
	return entity, nil
}

// FindOne retrieves and returns a single Record by Model.WherePri and Model.One.
// Also see Model.WherePri and Model.One.
func (m *arModel) FindOne(where ...interface{}) (*Entity, error) {
	one, err := m.M.FindOne(where...)
	if err != nil {
		return nil, err
	}
	var entity *Entity
	if err = one.Struct(&entity); err != nil && err != sql.ErrNoRows {
		return nil, err
	}
	return entity, nil
}

// FindAll retrieves and returns Result by by Model.WherePri and Model.All.
// Also see Model.WherePri and Model.All.
func (m *arModel) FindAll(where ...interface{}) ([]*Entity, error) {
	all, err := m.M.FindAll(where...)
	if err != nil {
		return nil, err
	}
	var entities []*Entity
	if err = all.Structs(&entities); err != nil && err != sql.ErrNoRows {
		return nil, err
	}
	return entities, nil
}

// Chunk iterates the table with given size and callback function.
func (m *arModel) Chunk(limit int, callback func(entities []*Entity, err error) bool) {
	m.M.Chunk(limit, func(result gdb.Result, err error) bool {
		var entities []*Entity
		err = result.Structs(&entities)
		if err == sql.ErrNoRows {
			return false
		}
		return callback(entities, err)
	})
}

// LockUpdate sets the lock for update for current operation.
func (m *arModel) LockUpdate() *arModel {
	return &arModel{m.M.LockUpdate()}
}

// LockShared sets the lock in share mode for current operation.
func (m *arModel) LockShared() *arModel {
	return &arModel{m.M.LockShared()}
}

// Unscoped enables/disables the soft deleting feature.
func (m *arModel) Unscoped() *arModel {
	return &arModel{m.M.Unscoped()}
}