跳到主要内容

Schema

快速概览

Schema 用于描述图中一种实体类型的定义,例如 UserGroup, 可包含以下配置:

  • 实体字段(或属性),例如:User 的姓名或年龄
  • 实体边(或关系),例如:User 的所属群组或好友
  • 数据库特定选项,例如:索引或唯一索引

以下是一个 Schema 示例:

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(),
}
}

实体 Schema 通常保存在项目根目录下的 ent/schema 目录中, 可通过 entc 生成,操作如下:

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

请注意,由于内部使用限制,某些 Schema 名称(如 Client)不可用。 您可以通过此处提到的注解方式来规避保留名称。

这只是另一种 ORM

如果您习惯于通过边(edges)来定义关系,这完全没问题。 数据建模方式与传统 ORM 相同,您可以使用 ent 实现任何传统 ORM 能够建模的场景。 本网站提供了许多示例帮助您入门,详见边关系章节。