// ==========================================================================
// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT.
// ==========================================================================

package internal

import (
	"context"

	"github.com/gogf/gf/v2/database/gdb"
	"github.com/gogf/gf/v2/frame/g"
)

// LessonDao is the data access object for the table hg_lesson.
type LessonDao struct {
	table    string             // table is the underlying table name of the DAO.
	group    string             // group is the database configuration group name of the current DAO.
	columns  LessonColumns      // columns contains all the column names of Table for convenient usage.
	handlers []gdb.ModelHandler // handlers for customized model modification.
}

// LessonColumns defines and stores column names for the table hg_lesson.
type LessonColumns struct {
	Id           string // id
	Name         string // 课程名
	Cover        string // 封面图
	CategoryId   string // 分类id
	Video        string // 介绍视频
	School       string // 所属学校
	Description  string // 课程概述
	Target       string // 授课目标
	Outline      string // 课程大纲
	Prerequisite string // 预备知识
	Reference    string // 参考资料
	Arrangement  string // 学时安排
	StartTime    string // 开课时间
	EndTime      string // 结课时间
	Revision     string // 乐观锁
	Question     string // 常见问题
	CreatedBy    string // 创建人
	CreatedTime  string // 创建时间
	UpdatedBy    string // 更新人
	UpdatedTime  string // 更新时间
}

// lessonColumns holds the columns for the table hg_lesson.
var lessonColumns = LessonColumns{
	Id:           "id",
	Name:         "name",
	Cover:        "cover",
	CategoryId:   "category_id",
	Video:        "video",
	School:       "school",
	Description:  "description",
	Target:       "target",
	Outline:      "outline",
	Prerequisite: "prerequisite",
	Reference:    "reference",
	Arrangement:  "arrangement",
	StartTime:    "start_time",
	EndTime:      "end_time",
	Revision:     "revision",
	Question:     "question",
	CreatedBy:    "created_by",
	CreatedTime:  "created_time",
	UpdatedBy:    "updated_by",
	UpdatedTime:  "updated_time",
}

// NewLessonDao creates and returns a new DAO object for table data access.
func NewLessonDao(handlers ...gdb.ModelHandler) *LessonDao {
	return &LessonDao{
		group:    "default",
		table:    "hg_lesson",
		columns:  lessonColumns,
		handlers: handlers,
	}
}

// DB retrieves and returns the underlying raw database management object of the current DAO.
func (dao *LessonDao) DB() gdb.DB {
	return g.DB(dao.group)
}

// Table returns the table name of the current DAO.
func (dao *LessonDao) Table() string {
	return dao.table
}

// Columns returns all column names of the current DAO.
func (dao *LessonDao) Columns() LessonColumns {
	return dao.columns
}

// Group returns the database configuration group name of the current DAO.
func (dao *LessonDao) Group() string {
	return dao.group
}

// Ctx creates and returns a Model for the current DAO. It automatically sets the context for the current operation.
func (dao *LessonDao) Ctx(ctx context.Context) *gdb.Model {
	model := dao.DB().Model(dao.table)
	for _, handler := range dao.handlers {
		model = handler(model)
	}
	return model.Safe().Ctx(ctx)
}

// Transaction wraps the transaction logic using function f.
// It rolls back the transaction and returns the error if function f returns a non-nil error.
// It commits the transaction and returns nil if function f returns nil.
//
// Note: Do not commit or roll back the transaction in function f,
// as it is automatically handled by this function.
func (dao *LessonDao) Transaction(ctx context.Context, f func(ctx context.Context, tx gdb.TX) error) (err error) {
	return dao.Ctx(ctx).Transaction(ctx, f)
}
