メインコンテンツへスキップする

インデックス

複数のフィールド

インデックスは、データ取得の 速度を向上させたり、一意性を定義したりするために、1つ以上のフィールドに設定できます。

package schema

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

// User holds the schema definition for the User entity.
type User struct {
ent.Schema
}

func (User) Indexes() []ent.Index {
return []ent.Index{
// 非一意インデックス
index.Fields("field1", "field2"),
// 一意インデックス
index.Fields("first_name", "last_name").
Unique(),
}
}

単一のフィールドを一意に設定するには、フィールドビルダーの Unique メソッドを以下のように使用してください:

func (User) Fields() []ent.Field {
return []ent.Field{
field.String("phone").
Unique(),
}
}

エッジ上のインデックス

インデックスは、フィールドとエッジの組み合わせでも設定できます。 主なユースケース は、特定の関係にあるフィールドに一意性を設定することです。 ひとつ、例を見てみましょう:

er-city-streets

この例では、Cityには複数のStreetがあります。そして、それぞれのCityごとに、同じ名前のStreetが存在しないよう設定したいと思います。

ent/schema/city.go

// City holds the schema definition for the City entity.
type City struct {
ent.Schema
}

// Fields of the City.
func (City) Fields() []ent.Field {
return []ent.Field{
field.String("name"),
}
}

// Edges of the City.
func (City) Edges() []ent.Edge {
return []ent.Edge{
edge.To("streets", Street.Type),
}
}

ent/schema/street.go

// Street holds the schema definition for the Street entity.
type Street struct {
ent.Schema
}

// Fields of the Street.
func (Street) Fields() []ent.Field {
return []ent.Field{
field.String("name"),
}
}

// Edges of the Street.
func (Street) Edges() []ent.Edge {
return []ent.Edge{
edge.From("city", City.Type).
Ref("streets").
Unique(),
}
}

// Indexes of the Street.
func (Street) Indexes() []ent.Index {
return []ent.Index{
index.Fields("name").
Edges("city").
Unique(),
}
}

example.go

func Do(ctx context.Context, client *ent.Client) error {
// `Save`とは違い、`SaveX`はエラーが起きた場合panicになります
tlv := client.City.
Create().
SetName("TLV").
SaveX(ctx)
nyc := client.City.
Create().
SetName("NYC").
SaveX(ctx)
// "ST"という道路を"TLV"に追加します
client.Street.
Create().
SetName("ST").
SetCity(tlv).
SaveX(ctx)
// "TLV"に"ST"はすでに作られているので
// この操作は失敗します。
if err := client.Street.
Create().
SetName("ST").
SetCity(tlv).
Exec(ctx); err == nil {
return fmt.Errorf("expecting creation to fail")
}
// "ST"という道路を"NYC"に追加します
client.Street.
Create().
SetName("ST").
SetCity(nyc).
SaveX(ctx)
return nil
}

完全な例はGitHubにあります

エッジフィールド上のインデックス

現在、Edgesカラムは常にFieldsカラムの後に追加されます。 しかし、インデックスによっては、特定の最適化を実現するために、これらのカラムを先に追加する必要があります。 Edge Fieldsを利用することで、この問題を回避できます。

// Card holds the schema definition for the Card entity.
type Card struct {
ent.Schema
}
// Fields of the Card.
func (Card) Fields() []ent.Field {
return []ent.Field{
field.String("number").
Optional(),
field.Int("owner_id").
Optional(),
}
}
// Edges of the Card.
func (Card) Edges() []ent.Edge {
return []ent.Edge{
edge.From("owner", User.Type).
Ref("card").
Field("owner_id").
Unique(),
}
}
// Indexes of the Card.
func (Card) Indexes() []ent.Index {
return []ent.Index{
index.Fields("owner_id", "number"),
}
}

方言サポート

インデックスは現在、SQLの方言のみをサポートしており、Gremlinはサポートしていません。 方言固有の機能は、アノテーションを使用して許可されます。 たとえば、MySQLでindex prefixesを使用するには、次のような設定を行います:

// Indexes of the User.
func (User) Indexes() []ent.Index {
return []ent.Index{
index.Fields("description").
Annotations(entsql.Prefix(128)),
index.Fields("c1", "c2", "c3").
Annotation(
entsql.PrefixColumn("c1", 100),
entsql.PrefixColumn("c2", 200),
)
}
}

上記のコードは、次の SQL 文を生成します:

CREATE INDEX `users_description` ON `users`(`description`(128))

CREATE INDEX `users_c1_c2_c3` ON `users`(`c1`(100), `c2`(200), `c3`)