// =================================================================================
// 本文件由 GoFrame CLI 工具自动生成，可按需修改。
// =================================================================================

package table

import (
	"context"

	"github.com/gogf/gf/v2/database/gdb"
)

// UserMessage 定义表 "user_message" 的字段及其属性。
// 该映射由 GoFrame ORM 内部使用，用于理解表结构。
var UserMessage = map[string]*gdb.TableField{
	"id": {
		Index:   0,
		Name:    "id",
		Type:    "bigint unsigned",
		Null:    false,
		Key:     "PRI",
		Default: nil,
		Extra:   "auto_increment",
		Comment: "",
	},
	"user_id": {
		Index:   1,
		Name:    "user_id",
		Type:    "bigint unsigned",
		Null:    false,
		Key:     "MUL",
		Default: nil,
		Extra:   "",
		Comment: "",
	},
	"title": {
		Index:   2,
		Name:    "title",
		Type:    "varchar(200)",
		Null:    false,
		Key:     "",
		Default: nil,
		Extra:   "",
		Comment: "",
	},
	"content": {
		Index:   3,
		Name:    "content",
		Type:    "text",
		Null:    false,
		Key:     "",
		Default: nil,
		Extra:   "",
		Comment: "",
	},
	"is_read": {
		Index:   4,
		Name:    "is_read",
		Type:    "tinyint",
		Null:    false,
		Key:     "",
		Default: "0",
		Extra:   "",
		Comment: "",
	},
	"created_at": {
		Index:   5,
		Name:    "created_at",
		Type:    "datetime",
		Null:    false,
		Key:     "",
		Default: nil,
		Extra:   "",
		Comment: "",
	},
	"updated_at": {
		Index:   6,
		Name:    "updated_at",
		Type:    "datetime",
		Null:    false,
		Key:     "",
		Default: nil,
		Extra:   "",
		Comment: "",
	},
	"deleted_at": {
		Index:   7,
		Name:    "deleted_at",
		Type:    "datetime",
		Null:    true,
		Key:     "MUL",
		Default: nil,
		Extra:   "",
		Comment: "",
	},
}

// UserMessageTableFields 将表字段定义注册到数据库实例。
// db：实现 gdb.DB 接口的数据库实例。
// schema：可选的 schema/命名空间名，尤其适用于支持 schema 的数据库。
func SetUserMessageTableFields(ctx context.Context, db gdb.DB, schema ...string) error {
	return db.GetCore().SetTableFields(ctx, "user_message", UserMessage, schema...)
}