entgo

• ent/ent 是什么？
  • 项目源自 facebook, 加入 LF
  • 支持 RESTful 接口
  • 基于代码生成的 ORM
    • 支持 MySQL, MariaDB, PostgreSQL, SQLite, Gremlin
  • 创建和更新使用 setter/getter
  • 支持生成 gqlgen 集成代码
  • 特点
    • 不基于 struct 定义模型，直接定义 Fields, Indexes, Edges
    • 支持定义校验
    • 能 mixin 公共模型
    • 添加 annotation 自定义信息
• 支持的类型
  • 所有 golang 数字类型
  • bool
  • string
  • time.Time
  • []byte
  • JSON
  • Enum
  • UUID
  • Other - 自定义 DB 类型和 Go 类型
• 支持全局唯一 ID - int 类型
  • migrate.WithGlobalUniqueID
  • ID 前面部分为 Table 索引
  • ent_types 表维护 表名->索引 关系
  • 因此一个 ID 能获取到类型信息
  • graphql Node ID 需要该能力
  • github gql 使用 String ID - 格式为 base64 04:User583231
• 参考
  • ent/contribs
    • entoas,entgql,entgrpc
  • ogen-go/ogen
    • 生成 OpenAPIv3
  • Neptune / Gremlin - experience compared to SQL backends
    • ent 早期后端为 Gremlin
  • ariga/atlas
    • DSL schema 管理
  • ariga/entcache
    • ent 缓存层
  • 核心成员成立的公司 ariga.io operational data graph

go get entgo.io/ent/cmd/ent

go mod init <project>
ent init User
go generate ./ent

# edge
go run entgo.io/ent/cmd/ent init Car Group

依赖包entgo.io/ent/cmd/ent

• feature
  • privacy
  • entql - EntQL DSL 抽象支持底层多种方言
  • schema/snapshot
    • 缓存之前 schema 解决合并冲突 #852
  • sql/schemaconfig - 针对 table 指定 schema
  • sql/lock - 生成 ForUpdate/ForShare
  • sql/modifier - 生成 Modify 调整语句
  • sql/versioned-migration
    • Schema 增加 Diff 和 NamedDiff
    • client.Schema.NamedDiff(ctx, "migration_name", schema.WithDir(dir))
      • 生成迁移到文件
    • 与现有 schema 进行 diff
  • sql/execquery
    • 生成 ExecContext, QueryContext
  • sql/upsert - 生成 OnConflict

Note

• Validator 不能获取到上下文，会 cast 成实际类型
• Save 顺序
  • 设置默认值
  • 没有 hooks
    • 校验字段
    • 保存
  • 有 hooks
    • 生成 Mutator - 校验、保存
    • 执行 hook
• ent.Policy - 访问策略控制
  • 通过拦截控制查询和修改 - 没有 Action 概念，只有 Query 和 Mutation
  • 三种决策结果
    • privacy.Allow
    • privacy.Deny
    • privacy.Skip

entql

• 动态 sql 生成
• 支持函数

select * from account where has_edge(owningUser)
--
select * from account where owning_user_id IS NOT NULL

select * from account where has_edge(owningUser,username = "wener")
-- args [wener]
SELECT * FROM "accounts" WHERE "accounts"."owning_user_id" IS NOT NULL AND "accounts"."owning_user_id" IN (SELECT "users"."id" FROM "users" WHERE "username" = $1)

select * from account where has_edge(owningUser,has_edge(department,name = "Test"))
-- args [Test]
SELECT * FROM "accounts" WHERE "accounts"."owning_user_id" IN (SELECT "users"."id" FROM "users" WHERE "users"."department_id" IN (SELECT "departments"."id" FROM "departments" WHERE "name" = $1))

FAQ

执行任意 SQL

• 生成时添加 sql/execquery 特性

// 暴露底层 DB
func (c *Client) DB() *sql.DB {
	if c.debug {
            return c.driver.(*dialect.DebugDriver).Driver.(*entsql.Driver).DB()
	}
	return c.driver.(*entsql.Driver).DB()
}

• ent/ent#85

Version

ent v0.10

• ariga/atlas 继承
  • 基于 HCL 的 DDL Schema 定义/迁移

package main
import (
    "context"
    "log"
    "<project>/ent"
    "<project>/ent/migrate"
    "entgo.io/ent/dialect/sql/schema"
)
func main() {
    client, err := ent.Open("mysql", "root:pass@tcp(localhost:3306)/test")
    if err != nil {
        log.Fatalf("failed connecting to mysql: %v", err)
    }
    defer client.Close()
    ctx := context.Background()
    // 使用 Atlas 执行迁移
    err = client.Schema.Create(ctx, schema.WithAtlas(true))
    if err != nil {
        log.Fatalf("failed creating schema resources: %v", err)
    }
}

ent v0.9

• Upsert/UpsertBulk
• Row-level locking
• 新的 entc.Extension API
• 支持 SQL Query 修饰符

id, err := client.User.
    Create().
    SetAge(30).
    SetName("Ariel").
    // upsert
    OnConflict().
    SetName("Mashraki").
    ID(ctx)

// UpsertBulk
err := client.User.
    CreateBulk(builders...).
    OnConflict().
    UpdateNewValues().
    Exec(ctx)

tx.User.Query().
    Where(user.Name(name)).
    // RLL
    ForUpdate().
    Only(ctx)

client.Pet.
    Query().
    //  SQL Modifier
    Modify(func(s *sql.Selector) {
        s.Select("SUM(LENGTH(name))")
    }).
    IntX(ctx)

ent v0.8

• entc/gen
  • 全局 Annotation
    • 会添加到 gen.Config
    • 类似于配置 entc
• entc/schema
  • 生成代码使用实际 GoType - #1428
    • 之前例如 ID 类型，会生成对应的 SQL 类型 - 例如 sql.NullString
  • UpdateOne 支持 Select 字段
  • 允许查询关闭 DISTINCT - 默认开启
• v0.8.0

type Annotation struct {
    Config *config.Config
}

func (Annotation) Name() string {
    return "GQL"
}

// 全局
var _ schema.Annotation = (*Annotation)(nil)