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

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

// V1MigrationsColumns defines and stores column names for the table migrations.
type V1MigrationsColumns struct {
	IdMigration        string // surrogate key
	Name               string // migration name, unique
	CreatedAt          string // date migrated or rolled back
	Statements         string // SQL statements for this migration
	RollbackStatements string // SQL statment for rolling back migration
	Status             string // update indicates it is a normal migration while rollback means this migration is rolled back
}

// v1MigrationsColumns holds the columns for the table migrations.
var v1MigrationsColumns = V1MigrationsColumns{
	IdMigration:        "id_migration",
	Name:               "name",
	CreatedAt:          "created_at",
	Statements:         "statements",
	RollbackStatements: "rollback_statements",
	Status:             "status",
}

// NewV1MigrationsDao creates and returns a new DAO object for table data access.
func NewV1MigrationsDao(handlers ...gdb.ModelHandler) *V1MigrationsDao {
	return &V1MigrationsDao{
		group:    "default",
		table:    "migrations",
		columns:  v1MigrationsColumns,
		handlers: handlers,
	}
}

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

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

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

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