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

package internal

import (
	"context"
	"database/sql"
	"time"

	"dashoo.cn/opms_parent/app/model/contract"
	"github.com/gogf/gf/database/gdb"
	"github.com/gogf/gf/frame/g"
	"github.com/gogf/gf/frame/gmvc"
)

// CtrContractAdvanceDao is the manager for logic model data accessing
// and custom defined data operations functions management.
type CtrContractAdvanceDao struct {
	gmvc.M
	DB      gdb.DB
	Table   string
	Columns ctrContractAdvanceColumns
}

// CtrContractAdvanceColumns defines and stores column names for table ctr_contract_advance.
type ctrContractAdvanceColumns struct {
	Id                 string // 主键ID
	AdvanceCode        string // 提前执行申请编号（系统自动生成）
	AdvanceName        string // 提前执行项目名称
	NboId              string // 关联项目ID（与正式合同一致）
	NboName            string // 项目名称
	CustId             string // 客户ID
	CustName           string // 客户名称
	ProductLine        string // 产品线
	IsBig              string // 是否大项目
	CustProvinceId     string // 所在省ID
	CustProvince       string // 所在省
	CustCityId         string // 所在市ID
	CustCity           string // 所在市
	SignatoryType      string // 签订单位类型 10终端 20经销商 30代理商
	SignatoryUnit      string // 合同签订单位
	DistributorId      string // 经销商ID
	DistributorName    string // 经销商名称
	EstimateAmount     string // 预估合同金额（提前执行必填）
	EarnestMoney       string // 质量/履约保证金
	AdvanceExecuteTime string // 计划提前执行开始时间
	EstimateSignTime   string // 预计正式合同签订时间
	AdvanceReason      string // 提前执行原因（必填）
	ExecuteScope       string // 提前执行范围/内容说明
	InchargeId         string // 负责人ID
	InchargeName       string // 负责人（销售）
	ApproStatus        string // 审核状态 10待提交 20审核中 30审核通过 40审核拒绝 50已撤销 60已转正式合同
	ContractId         string // 转换后的正式合同ID（转合同后回填）
	ContractCode       string // 正式合同编号
	ConvertTime        string // 转换为正式合同的时间
	ConvertBy          string // 转换操作人ID
	ConvertName        string // 转换操作人姓名
	Remark             string // 备注
	CreatedBy          string // 创建人ID
	CreatedName        string // 创建人姓名
	CreatedTime        string // 创建时间
	UpdatedBy          string // 更新人ID
	UpdatedName        string // 更新人姓名
	UpdatedTime        string // 更新时间
	DeletedTime        string // 删除时间（软删除）
}

var (
	// CtrContractAdvance is globally public accessible object for table ctr_contract_advance operations.
	CtrContractAdvance = CtrContractAdvanceDao{
		M:     g.DB("default").Model("ctr_contract_advance").Safe(),
		DB:    g.DB("default"),
		Table: "ctr_contract_advance",
		Columns: ctrContractAdvanceColumns{
			Id:                 "id",
			AdvanceCode:        "advance_code",
			AdvanceName:        "advance_name",
			NboId:              "nbo_id",
			NboName:            "nbo_name",
			CustId:             "cust_id",
			CustName:           "cust_name",
			ProductLine:        "product_line",
			IsBig:              "is_big",
			CustProvinceId:     "cust_province_id",
			CustProvince:       "cust_province",
			CustCityId:         "cust_city_id",
			CustCity:           "cust_city",
			SignatoryType:      "signatory_type",
			SignatoryUnit:      "signatory_unit",
			DistributorId:      "distributor_id",
			DistributorName:    "distributor_name",
			EstimateAmount:     "estimate_amount",
			EarnestMoney:       "earnest_money",
			AdvanceExecuteTime: "advance_execute_time",
			EstimateSignTime:   "estimate_sign_time",
			AdvanceReason:      "advance_reason",
			ExecuteScope:       "execute_scope",
			InchargeId:         "incharge_id",
			InchargeName:       "incharge_name",
			ApproStatus:        "appro_status",
			ContractId:         "contract_id",
			ContractCode:       "contract_code",
			ConvertTime:        "convert_time",
			ConvertBy:          "convert_by",
			ConvertName:        "convert_name",
			Remark:             "remark",
			CreatedBy:          "created_by",
			CreatedName:        "created_name",
			CreatedTime:        "created_time",
			UpdatedBy:          "updated_by",
			UpdatedName:        "updated_name",
			UpdatedTime:        "updated_time",
			DeletedTime:        "deleted_time",
		},
	}
)

func NewCtrContractAdvanceDao(tenant string) CtrContractAdvanceDao {
	var dao CtrContractAdvanceDao
	dao = CtrContractAdvanceDao{
		M:     g.DB(tenant).Model("ctr_contract_advance").Safe(),
		DB:    g.DB(tenant),
		Table: "ctr_contract_advance",
		Columns: ctrContractAdvanceColumns{
			Id:                 "id",
			AdvanceCode:        "advance_code",
			AdvanceName:        "advance_name",
			NboId:              "nbo_id",
			NboName:            "nbo_name",
			CustId:             "cust_id",
			CustName:           "cust_name",
			ProductLine:        "product_line",
			IsBig:              "is_big",
			CustProvinceId:     "cust_province_id",
			CustProvince:       "cust_province",
			CustCityId:         "cust_city_id",
			CustCity:           "cust_city",
			SignatoryType:      "signatory_type",
			SignatoryUnit:      "signatory_unit",
			DistributorId:      "distributor_id",
			DistributorName:    "distributor_name",
			EstimateAmount:     "estimate_amount",
			EarnestMoney:       "earnest_money",
			AdvanceExecuteTime: "advance_execute_time",
			EstimateSignTime:   "estimate_sign_time",
			AdvanceReason:      "advance_reason",
			ExecuteScope:       "execute_scope",
			InchargeId:         "incharge_id",
			InchargeName:       "incharge_name",
			ApproStatus:        "appro_status",
			ContractId:         "contract_id",
			ContractCode:       "contract_code",
			ConvertTime:        "convert_time",
			ConvertBy:          "convert_by",
			ConvertName:        "convert_name",
			Remark:             "remark",
			CreatedBy:          "created_by",
			CreatedName:        "created_name",
			CreatedTime:        "created_time",
			UpdatedBy:          "updated_by",
			UpdatedName:        "updated_name",
			UpdatedTime:        "updated_time",
			DeletedTime:        "deleted_time",
		},
	}
	return dao
}

// 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 (d *CtrContractAdvanceDao) Ctx(ctx context.Context) *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.M.Ctx(ctx)}
}

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

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

// Master marks the following operation on master node.
func (d *CtrContractAdvanceDao) Master() *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.M.Master()}
}

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

// Args sets custom arguments for model operation.
func (d *CtrContractAdvanceDao) Args(args ...interface{}) *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.M.Args(args...)}
}

// 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 (d *CtrContractAdvanceDao) LeftJoin(table ...string) *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.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 (d *CtrContractAdvanceDao) RightJoin(table ...string) *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.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 (d *CtrContractAdvanceDao) InnerJoin(table ...string) *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.M.InnerJoin(table...)}
}

// Fields sets the operation fields of the model, multiple fields joined using char ','.
// The parameter <fieldNamesOrMapStruct> can be type of string/map/*map/struct/*struct.
func (d *CtrContractAdvanceDao) Fields(fieldNamesOrMapStruct ...interface{}) *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.M.Fields(fieldNamesOrMapStruct...)}
}

// FieldsEx sets the excluded operation fields of the model, multiple fields joined using char ','.
// The parameter <fieldNamesOrMapStruct> can be type of string/map/*map/struct/*struct.
func (d *CtrContractAdvanceDao) FieldsEx(fieldNamesOrMapStruct ...interface{}) *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.M.FieldsEx(fieldNamesOrMapStruct...)}
}

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

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

// Filter marks filtering the fields which does not exist in the fields of the operated table.
func (d *CtrContractAdvanceDao) Filter() *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.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 (d *CtrContractAdvanceDao) Where(where interface{}, args ...interface{}) *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.M.Where(where, args...)}
}

// WherePri does the same logic as M.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 M.Where treats the condition
// as string "123".
func (d *CtrContractAdvanceDao) WherePri(where interface{}, args ...interface{}) *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.M.WherePri(where, args...)}
}

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

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

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

// Order sets the "ORDER BY" statement for the model.
func (d *CtrContractAdvanceDao) Order(orderBy ...string) *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.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 (d *CtrContractAdvanceDao) Limit(limit ...int) *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.M.Limit(limit...)}
}

// Offset sets the "OFFSET" statement for the model.
// It only makes sense for some databases like SQLServer, PostgreSQL, etc.
func (d *CtrContractAdvanceDao) Offset(offset int) *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.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 (d *CtrContractAdvanceDao) Page(page, limit int) *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.M.Page(page, limit)}
}

// Batch sets the batch operation number for the model.
func (d *CtrContractAdvanceDao) Batch(batch int) *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.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 (d *CtrContractAdvanceDao) Cache(duration time.Duration, name ...string) *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.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 (d *CtrContractAdvanceDao) Data(data ...interface{}) *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.M.Data(data...)}
}

// All does "SELECT FROM ..." statement for the model.
// It retrieves the records from table and returns the result as []*model.CtrContractAdvance.
// 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 M.Where function,
// see M.Where.
func (d *CtrContractAdvanceDao) All(where ...interface{}) ([]*contract.CtrContractAdvance, error) {
	all, err := d.M.All(where...)
	if err != nil {
		return nil, err
	}
	var entities []*contract.CtrContractAdvance
	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 *model.CtrContractAdvance.
// 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 M.Where function,
// see M.Where.
func (d *CtrContractAdvanceDao) One(where ...interface{}) (*contract.CtrContractAdvance, error) {
	one, err := d.M.One(where...)
	if err != nil {
		return nil, err
	}
	var entity *contract.CtrContractAdvance
	if err = one.Struct(&entity); err != nil && err != sql.ErrNoRows {
		return nil, err
	}
	return entity, nil
}

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

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

// Struct retrieves one record from table and converts it into given struct.
// The parameter <pointer> should be type of *struct/**struct. If type **struct is given,
// it can create the struct internally during converting.
//
// The optional parameter <where> is the same as the parameter of Model.Where function,
// see Model.Where.
//
// Note that it returns sql.ErrNoRows if there's no record retrieved with the given conditions
// from table and <pointer> is not nil.
//
// Eg:
// user := new(User)
// err  := dao.User.Where("id", 1).Struct(user)
//
// user := (*User)(nil)
// err  := dao.User.Where("id", 1).Struct(&user)
func (d *CtrContractAdvanceDao) Struct(pointer interface{}, where ...interface{}) error {
	return d.M.Struct(pointer, where...)
}

// Structs retrieves records from table and converts them into given struct slice.
// The parameter <pointer> should be type of *[]struct/*[]*struct. It can create and fill the struct
// slice internally during converting.
//
// The optional parameter <where> is the same as the parameter of Model.Where function,
// see Model.Where.
//
// Note that it returns sql.ErrNoRows if there's no record retrieved with the given conditions
// from table and <pointer> is not empty.
//
// Eg:
// users := ([]User)(nil)
// err   := dao.User.Structs(&users)
//
// users := ([]*User)(nil)
// err   := dao.User.Structs(&users)
func (d *CtrContractAdvanceDao) Structs(pointer interface{}, where ...interface{}) error {
	return d.M.Structs(pointer, where...)
}

// Scan automatically calls Struct or Structs function according to the type of parameter <pointer>.
// It calls function Struct if <pointer> is type of *struct/**struct.
// It calls function Structs if <pointer> is type of *[]struct/*[]*struct.
//
// The optional parameter <where> is the same as the parameter of Model.Where function,
// see Model.Where.
//
// Note that it returns sql.ErrNoRows if there's no record retrieved and given pointer is not empty or nil.
//
// Eg:
// user  := new(User)
// err   := dao.User.Where("id", 1).Scan(user)
//
// user  := (*User)(nil)
// err   := dao.User.Where("id", 1).Scan(&user)
//
// users := ([]User)(nil)
// err   := dao.User.Scan(&users)
//
// users := ([]*User)(nil)
// err   := dao.User.Scan(&users)
func (d *CtrContractAdvanceDao) Scan(pointer interface{}, where ...interface{}) error {
	return d.M.Scan(pointer, where...)
}

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

// LockUpdate sets the lock for update for current operation.
func (d *CtrContractAdvanceDao) LockUpdate() *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.M.LockUpdate()}
}

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

// Unscoped enables/disables the soft deleting feature.
func (d *CtrContractAdvanceDao) Unscoped() *CtrContractAdvanceDao {
	return &CtrContractAdvanceDao{M: d.M.Unscoped()}
}