索引

列索引

你可以通过在想要创建索引的列上使用 @Index 来为特定列创建数据库索引。你可以为实体的任何列创建索引。示例：

import { Entity, PrimaryGeneratedColumn, Column, Index } from "typeorm"

@Entity()
export class User {
    @PrimaryGeneratedColumn()
    id: number

    @Index()
    @Column()
    firstName: string

    @Column()
    @Index()
    lastName: string
}

你也可以指定索引名称：

import { Entity, PrimaryGeneratedColumn, Column, Index } from "typeorm"

@Entity()
export class User {
    @PrimaryGeneratedColumn()
    id: number

    @Index("name1-idx")
    @Column()
    firstName: string

    @Column()
    @Index("name2-idx")
    lastName: string
}

唯一索引

要创建唯一索引，需要在索引选项中指定 { unique: true }：

注意：CockroachDB 将唯一索引存储为 UNIQUE 约束

import { Entity, PrimaryGeneratedColumn, Column, Index } from "typeorm"

@Entity()
export class User {
    @PrimaryGeneratedColumn()
    id: number

    @Index({ unique: true })
    @Column()
    firstName: string

    @Column()
    @Index({ unique: true })
    lastName: string
}

多列索引

要创建包含多列的索引，需要将 @Index 放在实体类本身上，并指定需要包含在索引内的所有列属性名。示例：

import { Entity, PrimaryGeneratedColumn, Column, Index } from "typeorm"

@Entity()
@Index(["firstName", "lastName"])
@Index(["firstName", "middleName", "lastName"], { unique: true })
export class User {
    @PrimaryGeneratedColumn()
    id: number

    @Column()
    firstName: string

    @Column()
    middleName: string

    @Column()
    lastName: string
}

空间索引

MySQL、CockroachDB 和 PostgreSQL（当可用 PostGIS 时）支持空间索引。

在 MySQL 中，对使用空间类型的列（geometry、point、linestring、 polygon、multipoint、multilinestring、multipolygon、 geometrycollection）添加 Index 并设置 { spatial: true } 即可创建空间索引：

@Entity()
export class Thing {
    @Column("point")
    @Index({ spatial: true })
    point: string
}

对使用空间类型（geometry、geography）的列创建空间索引，添加带有 { spatial: true } 的 Index：

export interface Geometry {
    type: "Point"
    coordinates: [Number, Number]
}

@Entity()
export class Thing {
    @Column("geometry", {
        spatialFeatureType: "Point",
        srid: 4326,
    })
    @Index({ spatial: true })
    point: Geometry
}

并发创建

为了避免在 Postgres 中创建和删除索引时获取 ACCESS EXCLUSIVE 锁，可以使用 CONCURRENTLY 修饰符并发创建索引。如果要使用并发选项，需要在数据源配置中将 migrationsTransactionMode 设为 none。

TypeORM 支持在索引上指定 concurrent 选项时生成包含该选项的 SQL。

@Index(["firstName", "middleName", "lastName"], { concurrent: true })

更多信息请参阅 Postgres 官方文档。

索引类型

如果需要为索引指定自定义类型，可以使用 type 属性。如果设置了 spatial 属性，则该字段会被忽略。

@Index({ type: 'hash' })

该功能当前仅支持 PostgreSQL。

禁用同步

由于数据库特性差异较大，以及自动获取现有索引信息并同步的多重问题，TypeORM 不支持某些索引选项和定义（如 lower、pg_trgm）。这类索引应手动创建（例如，在迁移文件中）并使用任何所需索引签名。为防止 TypeORM 在同步时删除这些索引，应在 @Index 装饰器上使用 synchronize: false 选项让其忽略这些索引。

例如，创建一个不区分大小写的索引：

CREATE INDEX "POST_NAME_INDEX" ON "post" (lower("name"))

之后，应为该索引禁用同步以避免下次模式同步时被删除：

@Entity()
@Index("POST_NAME_INDEX", { synchronize: false })
export class Post {
    @PrimaryGeneratedColumn()
    id: number

    @Column()
    name: string
}

列索引​

唯一索引​

多列索引​

空间索引​

并发创建​

索引类型​

禁用同步​

列索引