Go Ent ORM框架教程 > 内容正文

索引定义

1. 索引概念与应用

1.1 什么是索引

索引是数据库管理系统中用于加速数据检索操作的数据结构。它可以被看作是数据库中的“目录”，通过索引可以快速定位数据表中的数据，避免进行全表扫描，从而显著提高查询效率。在实际应用中，正确地使用索引可以大幅提升数据库的性能。

1.2 索引的类型

索引有多种不同的类型，每种索引的设计和优化都有各自的应用场景：

单字段索引：索引只包含一个字段，可以快速查询那些只依赖于一个条件的场景。
联合索引：索引包含多个字段，对于查询条件包含这些字段的查询可以提供优化。
唯一索引：确保索引字段的唯一性，不允许重复值的存在。唯一索引既可以是单字段的，也可以是联合多个字段的。

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字段上的联合索引。这意味着当你执行包含这两个字段的查询操作时，数据库可以快速定位到符合条件的数据。

联合索引不仅能够加快查询速度，还能够支持基于索引的排序操作，提供更高效的数据检索性能。在设计联合索引时，通常将过滤性较高的字段放在索引的前面，以便数据库优化器能够更好地利用索引。

3. 边缘索引（Edge Indexes）

在ent框架中，边缘索引是一种通过边缘（关联关系）定义索引的方式。这种机制通常用于在特定关系下保证字段的唯一性。例如，如果你的数据库模型包括城市和街道，而每个城市下的街道名称需要唯一，那么可以利用边缘索引来实现这一点。

// ent/schema/street.go 文件定义Street实体的schema
type Street struct {
    ent.Schema
}

func (Street) Fields() []ent.Field {
    // 定义字段
    return []ent.Field{
        field.String("name"),
    }
}

func (Street) Edges() []ent.Edge {
    // 定义与City的边缘关系，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实体的schema
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”为真的行
    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{
        // 使用注解定义索引的列排序规则
        index.Fields("c1", "c2", "c3").
            Annotations(entsql.DescColumns("c1", "c2")),
    }
}

使用注解功能，开发者可以非常灵活地定制索引以优化数据库性能和结构。

梯子教程-tizi365.com

Go Ent ORM框架教程

定义模式