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

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

// BookshelvesColumns defines and stores column names for the table bookshelves.
type BookshelvesColumns struct {
	Id                string // 记录ID
	UserId            string // 用户ID
	BookId            string // 小说ID
	AddedAt           string // 加入书架时间
	LastReadChapterId string // 最后阅读章节ID
	LastReadPercent   string // 阅读进度百分比（0.00~100.00）
	LastReadAt        string // 最后阅读时间
	ReadStatus        string // 阅读状态：1=正在读，2=已读完，3=已收藏
}

// bookshelvesColumns holds the columns for the table bookshelves.
var bookshelvesColumns = BookshelvesColumns{
	Id:                "id",
	UserId:            "user_id",
	BookId:            "book_id",
	AddedAt:           "added_at",
	LastReadChapterId: "last_read_chapter_id",
	LastReadPercent:   "last_read_percent",
	LastReadAt:        "last_read_at",
	ReadStatus:        "read_status",
}

// NewBookshelvesDao creates and returns a new DAO object for table data access.
func NewBookshelvesDao(handlers ...gdb.ModelHandler) *BookshelvesDao {
	return &BookshelvesDao{
		group:    "default",
		table:    "bookshelves",
		columns:  bookshelvesColumns,
		handlers: handlers,
	}
}

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

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

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

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