// ==========================================================================
// 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"
)

// ChaptersDao is the data access object for the table chapters.
type ChaptersDao 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  ChaptersColumns    // columns contains all the column names of Table for convenient usage.
	handlers []gdb.ModelHandler // handlers for customized model modification.
}

// ChaptersColumns defines and stores column names for the table chapters.
type ChaptersColumns struct {
	Id            string // 章节ID
	BookId        string // 小说ID
	Title         string // 章节标题
	Content       string // 章节内容
	WordCount     string // 章节字数
	Sort          string // 排序序号
	IsLocked      string // 是否锁定：0=免费，1=需积分解锁
	RequiredScore string // 解锁该章节所需积分
	CreatedAt     string // 创建时间
	UpdatedAt     string // 更新时间
	DeletedAt     string // 软删除时间戳
}

// chaptersColumns holds the columns for the table chapters.
var chaptersColumns = ChaptersColumns{
	Id:            "id",
	BookId:        "book_id",
	Title:         "title",
	Content:       "content",
	WordCount:     "word_count",
	Sort:          "sort",
	IsLocked:      "is_locked",
	RequiredScore: "required_score",
	CreatedAt:     "created_at",
	UpdatedAt:     "updated_at",
	DeletedAt:     "deleted_at",
}

// NewChaptersDao creates and returns a new DAO object for table data access.
func NewChaptersDao(handlers ...gdb.ModelHandler) *ChaptersDao {
	return &ChaptersDao{
		group:    "default",
		table:    "chapters",
		columns:  chaptersColumns,
		handlers: handlers,
	}
}

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

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

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

// Group returns the database configuration group name of the current DAO.
func (dao *ChaptersDao) 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 *ChaptersDao) 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 *ChaptersDao) Transaction(ctx context.Context, f func(ctx context.Context, tx gdb.TX) error) (err error) {
	return dao.Ctx(ctx).Transaction(ctx, f)
}
