跳到主要内容

模式介绍

快速摘要

模式描述了图中某实体类型的定义,例如 UserGroup,可包含以下配置:

  • 实体字段(或属性),例如:User的 name 或 age(用户的姓名和年龄)。
  • 实体边(或关系),例如:User 的 groups 或 User 的 friends(用户所在的组或用户的好友)。
  • 数据库特定选项,例如:indexes 或 unique indexes(索引或唯一索引)。

这是一个模式的示例:

package schema

import (
"entgo.io/ent"
"entgo.io/ent/schema/field"
"entgo.io/ent/schema/edge"
"entgo.io/ent/schema/index"
)

type User struct {
ent.Schema
}

func (User) Fields() []ent.Field {
return []ent.Field{
field.Int("age"),
field.String("name"),
field.String("nickname").
Unique(),
}
}

func (User) Edges() []ent.Edge {
return []ent.Edge{
edge.To("groups", Group.Type),
edge.To("friends", User.Type),
}
}

func (User) Indexes() []ent.Index {
return []ent.Index{
index.Fields("age", "name").
Unique(),
}
}

实体模式通常存储在项目根目录的 ent/schema 目录中, 通过 entc 的方式生成:

go run -mod=mod entgo.io/ent/cmd/ent new User Group
备注

请注意,某些模式名称(如 Client)因 内部使用 不可用。 您可以通过使用 此处 所述的注解来规避保留名称。

不过是另一种 ORM

如果你习惯于基于边的关系定义,那也没问题。建模方式是相同的。 你可以用 ent 实现任何传统 ORM 能实现的建模功能。 本网站的 部分提供了大量示例,可帮助你快速入门。