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

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

// UserReadRecordsColumns defines and stores column names for the table user_read_records.
type UserReadRecordsColumns struct {
	Id        string // 记录ID
	UserId    string // 用户ID
	BookId    string // 小说ID
	ChapterId string // 章节ID
	Progress  string // 阅读进度百分比(0-100)
	ReadAt    string // 阅读时间
	CreatedAt string // 创建时间
	UpdatedAt string // 更新时间
}

// userReadRecordsColumns holds the columns for the table user_read_records.
var userReadRecordsColumns = UserReadRecordsColumns{
	Id:        "id",
	UserId:    "user_id",
	BookId:    "book_id",
	ChapterId: "chapter_id",
	Progress:  "progress",
	ReadAt:    "read_at",
	CreatedAt: "created_at",
	UpdatedAt: "updated_at",
}

// NewUserReadRecordsDao creates and returns a new DAO object for table data access.
func NewUserReadRecordsDao(handlers ...gdb.ModelHandler) *UserReadRecordsDao {
	return &UserReadRecordsDao{
		group:    "default",
		table:    "user_read_records",
		columns:  userReadRecordsColumns,
		handlers: handlers,
	}
}

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

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

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

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