load

type BuilderInfo struct {
	// PkgPath 是加载的Schema包的Go package路径，之后会传给gen.Config。
	PkgPath string
	// Module 加载的entity package的模块信息。
	Module *packages.Module
	// Databases 从Schema中提取出的database的配置信息。
	// Config.Dbs中的只是获得数据库的名字和它拥有的entity。Databases获得的是完整的数据库配置信息。
	Databases []*Database
	// ExtraCodes Schema中不是数据库或者实体的代码。
	ExtraCodes []string
}

type Config struct {
	// Path 加载的Schema的路径。
	Path string
	// Entities 加载的Schema中拥有匿名字段[entity.Entity]的结构体的名称。
	Entities []string
	// BuildFlags 传递给go build的标志。
	BuildFlags []string
	// Dbs 加载的Schema中拥有匿名字段[entity.Database]的结构体的名称。
	Dbs []DbConfig
}

type Database struct {
	// Name 数据库的名称。
	Name string
	// Tag 数据库的标签，开发者通过tag来实现数据库的连接和数据库实例的匹配。
	Tag string
	// Type 数据库类型。
	Type dialect.DbDriver
	// EntityMap 数据库中的entity的信息。
	EntityMap EntityMap
	// Entities 数据库中的entity的信息。
	Entities map[string]*Entity
}

type DbConfig struct {
	// Name 数据库名称。
	Name string
	// Entities 存储这个database所拥有的。
	Entities EntityMap
}

type Entity struct {
	// Name entity的名称
	Name string `json:"name,omitempty"`
	// AttrName entity的属性名称
	AttrName string `json:"attr_name,omitempty"`
	// Comment entity的注释
	Comment string `json:"comment,omitempty"`
	// Config entity配置
	Config entity.EntityConfig `json:"config,omitempty"`
	// Fields entity的字段
	Fields []*Field `json:"fields,omitempty"`
	// ImportPkgs 导入的Go package路径
	ImportPkgs []string
	// Sequences entity的关联序列
	Sequences []entity.Sequence
	// Relations entity的关系
	Relations []*Relation
}

type EntityMap map[string]string

type ExeTmplConfig struct {
	// Config 模版文件会匹配Config每个字段的值，例如[.Names]
	Config *Config
	// Package 模版文件会匹配[.Package]的值
	Package string
}

type Field struct {
	entity.Descriptor
	// ValueType 字段的值在go中对应的类型，比如"entity.Int64"的ValueType为"int64"。
	ValueType string `json:"value_type,omitempty"`
	// Validators 字段的验证器数量
	Validators int `json:"validators,omitempty"`
	// StoragerType 字段的存储器的类型，这个是字段的作用是关联已经定义的好的存储器。比如field.IntStorage[int16]
	StoragerType string `json:"storager_type,omitempty"`
	// StoragerOrigType 字段的存储器去除泛型后的名字，比如field.IntStorage[int16]变成field.IntStorage
	StoragerOrigType string `json:"storager_orig_type,omitempty"`
	// StoragerPkg 字段的存储器的包路径
	StoragerPkg string `json:"storager_pkg,omitempty"`
}

type Relation struct {
	// Desc entity在自定义时的信息
	Desc RelationDesc
	// Principal 主体实体
	Principal RelationEntity
	// Dependent 依赖实体
	Dependent RelationEntity
}

type RelationDesc struct {
	Has          Entity
	With         Entity
	HasRel       entity.Rel
	WithRel      entity.Rel
	ForeignKey   Field
	ReferenceKey Field
	Constraint   string
	Update       string
	Delete       string
}

type RelationEntity struct {
	Name string `json:"name,omitempty"`
	// AttrName entity的属性名称
	AttrName string `json:"attr_name,omitempty"`
	Field    *Field
	Rel      entity.Rel
}