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

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

// UsersColumns defines and stores column names for the table hg_users.
type UsersColumns struct {
	Id                string // id
	Phone             string // 手机号
	Nickname          string // 昵称
	Email             string // 邮箱
	Avatar            string // 头像URL
	Introduce         string // 个人简介
	Password          string // 密码
	Salt              string // 密码盐
	Realname          string // 真实姓名
	Gender            string // 性别
	Birthday          string // 生日
	School            string // 学校
	Grade             string // 学历
	Major             string // 专业
	Status            string // 用户状态
	VerificationToken string // 邮箱验证令牌
	EmailVerified     string // 邮箱验证状态
	CreatedAt         string // 注册时间
	LastLogin         string // 最后登录时间
	LoginCount        string // 累计登录次数
}

// usersColumns holds the columns for the table hg_users.
var usersColumns = UsersColumns{
	Id:                "id",
	Phone:             "phone",
	Nickname:          "nickname",
	Email:             "email",
	Avatar:            "avatar",
	Introduce:         "introduce",
	Password:          "password",
	Salt:              "salt",
	Realname:          "realname",
	Gender:            "gender",
	Birthday:          "birthday",
	School:            "school",
	Grade:             "grade",
	Major:             "major",
	Status:            "status",
	VerificationToken: "verification_token",
	EmailVerified:     "email_verified",
	CreatedAt:         "created_at",
	LastLogin:         "last_login",
	LoginCount:        "login_count",
}

// NewUsersDao creates and returns a new DAO object for table data access.
func NewUsersDao(handlers ...gdb.ModelHandler) *UsersDao {
	return &UsersDao{
		group:    "default",
		table:    "hg_users",
		columns:  usersColumns,
		handlers: handlers,
	}
}

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

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

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

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