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

// StoresDao is the data access object for the table stores.
type StoresDao 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 StoresColumns // columns contains all the column names of Table for convenient usage.
}

// StoresColumns defines and stores column names for the table stores.
type StoresColumns struct {
	Id           string // 门店ID
	MerchantId   string // 所属商户ID
	Name         string // 门店名称
	StoreCode    string // 门店编号
	Address      string // 门店地址
	ContactName  string // 联系人姓名
	ContactPhone string // 联系人电话
	Status       string // 状态：1=正常营业，2=暂停营业
	CreatedAt    string // 创建时间
	UpdatedAt    string // 更新时间
	DeletedAt    string // 软删除时间戳
}

// storesColumns holds the columns for the table stores.
var storesColumns = StoresColumns{
	Id:           "id",
	MerchantId:   "merchant_id",
	Name:         "name",
	StoreCode:    "store_code",
	Address:      "address",
	ContactName:  "contact_name",
	ContactPhone: "contact_phone",
	Status:       "status",
	CreatedAt:    "created_at",
	UpdatedAt:    "updated_at",
	DeletedAt:    "deleted_at",
}

// NewStoresDao creates and returns a new DAO object for table data access.
func NewStoresDao() *StoresDao {
	return &StoresDao{
		group:   "default",
		table:   "stores",
		columns: storesColumns,
	}
}

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

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

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

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