インデックスの定義

1. インデックスの概念と利用

1.1 インデックスとは

インデックスはデータベース管理システムで使用されるデータ構造であり、データの取得操作を高速化するために利用されます。これは、データベース内の「ディレクトリ」と見なすことができ、データテーブル内のデータを迅速に探し出すことができるようにします。これにより、完全なテーブルのスキャンを避け、クエリの効率を大幅に向上させます。実際のアプリケーションでは、適切にインデックスを使用することでデータベースのパフォーマンスを大幅に向上させることができます。

1.2 インデックスの種類

さまざまな種類のインデックスがあり、それぞれ異なるアプリケーションシナリオ向けに設計されています。

• 単一フィールドインデックス: 1つのフィールドのみを含むインデックスで、迅速なクエリに1つの条件に依存するシナリオに適しています。
• 複合インデックス: 複数のフィールドを含むインデックスで、これらのフィールドを含むクエリの最適化を提供します。
• ユニークインデックス: インデックスフィールドの一意性を確保し、重複した値の存在を許さないものです。ユニークインデックスは単一フィールドまたは複合のどちらでも構成できます。

2. インデックスの定義

2.1 フィールドインデックスの定義

単一フィールドインデックスの作成は、データテーブルの特定の列にインデックスを確立することを意味し、Fields メソッドを使用して実現できます。以下の例では、User エンティティの phone フィールドにインデックスを作成する方法が示されています。

func (User) Fields() []ent.Field {
    return []ent.Field{
        field.String("phone"),
    }
}
func (User) Indexes() []ent.Index {
    // 単一フィールドインデックスを作成します。
    return []ent.Index{
        index.Fields("phone"),
    }
}

このコードスニペットでは、phone フィールドにインデックスが付けられています。これにより、システムは phone フィールドをクエリする際にインデックスを利用できます。

2.2 ユニークインデックスの定義

ユニークインデックスは、インデックスされた列のデータの一意性を確保します。これは、フィールドに Unique メソッドを追加することで作成できます。以下の例は、単一および複数のフィールドに対するユニークインデックスの作成を示しています。

単一フィールドに対するユニークインデックスの作成:

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

この例では、email フィールドが一意と指定され、データベース内の各ユーザーの email が一意であることが確保されます。

複数のフィールドの組み合わせに対するユニークインデックスの作成:

func (User) Indexes() []ent.Index {
    return []ent.Index{
        // 複数のフィールドに対するユニークインデックスを作成します。
        index.Fields("first_name", "last_name").Unique(),
    }
}

このコードは、first_name と last_name フィールドの組み合わせに対する複合ユニークインデックスを定義しており、両フィールドに同じ値のレコードが発生しないようにしています。

2.3 複合インデックスの定義

クエリ条件に複数のフィールドが関わる場合、複合インデックスが使用されます。複合インデックスはインデックスで定義された順序でデータを保存します。インデックスの順序はクエリのパフォーマンスに大きな影響を与えるため、複合インデックスを定義する際には、フィールドの順序をクエリパターンに基づいて決定する必要があります。

以下は、複合インデックスの作成例です。

func (User) Indexes() []ent.Index {
    return []ent.Index{
        // 複数のフィールドによる複合インデックスを作成します。
        index.Fields("country", "city"),
    }
}

この例では、country と city フィールドに複合インデックスが作成されています。これにより、これら2つのフィールドを関連するクエリ操作を行う際に、データベースは迅速に条件に合致するデータをロケートすることができます。

複合インデックスはクエリのパフォーマンスを向上させるだけでなく、インデックスベースのソート操作をサポートし、より効率的なデータの取得パフォーマンスを提供します。複合インデックスの設計では、高い選択度を持つフィールドをインデックスの最初に配置することが一般的であり、これによりデータベースオプティマイザがより良くインデックスを利用できるようになります。

3. エッジインデックス

ent フレームワークでは、エッジ（関係）を通じてインデックスを定義することで、エッジインデックスを利用することができます。このメカニズムは、特定の関係の下でフィールドの一意性を保証するために通常使用されます。たとえば、データベースモデルに都市と通りが含まれており、各都市の下の通りの名前が一意である必要がある場合、エッジインデックスを利用してこれを達成することができます。

// ent/schema/street.go ファイルは Street エンティティのスキーマを定義します。
type Street struct {
    ent.Schema
}

func (Street) Fields() []ent.Field {
    // フィールドを定義
    return []ent.Field{
        field.String("name"),
    }
}

func (Street) Edges() []ent.Edge {
    // Street が City に属するというエッジ関係を定義します。
    return []ent.Edge{
        edge.From("city", City.Type).
            Ref("streets").
            Unique(),
    }
}

func (Street) Indexes() []ent.Index {
    // エッジを通じて一意のインデックスを作成し、同じ都市内で通りの名前の一意性を保証します。
    return []ent.Index{
        index.Fields("name").
            Edges("city").
            Unique(),
    }
}

この例では、Street エンティティを作成し、City エンティティと関連付けます。Street エンティティの Indexes メソッドでエッジインデックスを定義することで、各都市の下の通りの名前が一意であることを保証します。

第5章: 高度なインデックスオプション

5.1 フルテキストインデックスとハッシュインデックス

フルテキストインデックスとハッシュインデックスは、MySQL と PostgreSQL で使用されるユニークなインデックスのタイプです。これらは異なるクエリ最適化シナリオに使用されます。

フルテキストインデックスは、テキストデータの検索に一般的に使用され、特に単語の一致検索などの複雑な検索を実行する必要がある場合に適しています。MySQL と PostgreSQL の両方がフルテキストインデックスをサポートしています。例えば、MySQL では次のようにフルテキストインデ

// ent/schema/user.go は User エンティティのスキーマを定義します。
func (User) Indexes() []ent.Index {
    // MySQL の FULLTEXT カテゴリを使用してフルテキストインデックスを作成します。
    return []ent.Index{
        index.Fields("description").
            Annotations(entsql.IndexTypes(map[string]string{
                dialect.MySQL: "FULLTEXT",
            })),
    }
}

ハッシュインデックスは等しいクエリに特に適しており、ソートや範囲クエリをサポートしていません。PostgreSQL では、次のようにハッシュインデックスを使用できます。

func (User) Indexes() []ent.Index {
    // HASH タイプのインデックスを定義します。
    return []ent.Index{
        index.Fields("c4").
            Annotations(entsql.IndexType("HASH")),
    }
}

5.2 部分インデックスとインデックスプレフィックス

部分インデックスは、特定の条件を満たすテーブル内の行のみをインデックス化するタイプのインデックスです。SQLite と PostgreSQL では、WHERE 句を使用して部分インデックスを作成できます。

例えば、PostgreSQL で部分インデックスを定義する場合:

func (User) Indexes() []ent.Index {
    // "nickname" フィールドに部分インデックスを作成し、"active" が true の行のみを含めます。
    return []ent.Index{
        index.Fields("nickname").
            Annotations(
                entsql.IndexWhere("active"),
            ),
    }
}

インデックスプレフィックスは、特に MySQL でテキストフィールドに有用であり、インデックスの作成時間を短縮し、インデックスが占めるスペースを減らし、高いパフォーマンスを提供できます。以下のように、MySQL ではプレフィックス付きのインデックスを定義できます:

func (User) Indexes() []ent.Index {
    // プレフィックスを使用してインデックスを作成します。
    return []ent.Index{
        index.Fields("description").
            Annotations(entsql.Prefix(128)),
    }
}

5.3 インデックス注釈とカスタマイズ

ent では、Annotations は開発者がインデックスをカスタマイズする機能です。インデックスのタイプを定義したり、ソートルールを設定したりすることができます。

例えば、以下のコードは、インデックスの列のソートルールを指定する方法を示しています:

func (User) Indexes() []ent.Index {
    return []ent.Index{
        // annotations を使用して、インデックスの列のソートルールを定義します。
        index.Fields("c1", "c2", "c3").
            Annotations(entsql.DescColumns("c1", "c2")),
    }
}

注釈機能を使用することで、開発者は柔軟にインデックスをカスタマイズしてデータベースのパフォーマンスと構造を最適化できます。