索引

Prisma ORM 允许配置数据库索引、唯一约束和主键约束。此功能在版本 4.0.0 及更高版本中普遍可用（General Availability）。在版本 3.5.0 及更高版本中，您可以通过 extendedIndexes 预览特性启用此功能。

版本 3.6.0 还通过新的 @@fulltext 属性引入了对 MySQL 和 MongoDB 中全文索引的内省和迁移的支持，此属性可通过 fullTextIndex 预览特性获得。

警告

如果您从低于 4.0.0 的版本升级，如果您已有数据库使用了这些特性，则这些索引配置和全文索引的更改可能是重大更改。有关如何升级的更多信息，请参阅从先前版本升级。

索引配置

您可以使用以下属性参数配置索引、唯一约束和主键约束

length 参数允许您为 String 和 Bytes 类型值的索引子部分指定最大长度
- 适用于 @id、@@id、@unique、@@unique 和 @@index 属性
- 仅限 MySQL
sort 参数允许您指定约束或索引条目在数据库中的存储顺序
- 适用于所有数据库的 @unique、@@unique 和 @@index 属性，以及 SQL Server 的 @id 和 @@id 属性
type 参数允许您支持 PostgreSQL 默认 BTree 访问方法之外的其他索引访问方法
- 适用于 @@index 属性
- 仅限 PostgreSQL
- 支持的索引访问方法：Hash、Gist、Gin、SpGist 和 Brin
clustered 参数允许您配置约束或索引是聚集（clustered）还是非聚集（non-clustered）
- 适用于 @id、@@id、@unique、@@unique 和 @@index 属性
- 仅限 SQL Server

有关每个特性首次引入的版本详情，请参阅链接的部分。

使用 `length` 配置索引长度 (MySQL)

length 参数是 MySQL 特有的，允许您在 String 和 Byte 类型的列上定义索引和约束。对于这些类型，当值的完整长度超出 MySQL 对索引大小的限制时，MySQL 要求您指定索引值子部分的最大长度。有关更多详情，请参阅MySQL 文档。

length 参数适用于 @id、@@id、@unique、@@unique 和 @@index 属性。此功能在版本 4.0.0 及更高版本中普遍可用，并在版本 3.5.0 及更高版本中作为 extendedIndexes 预览特性的一部分提供。

例如，以下数据模型声明了一个最大长度为 3000 个字符的 id 字段

schema.prisma

model Id {
  id String @id @db.VarChar(3000)
}

这在 MySQL 中是无效的，因为它超出了 MySQL 的索引存储限制，因此 Prisma ORM 会拒绝该数据模型。生成的 SQL 将被数据库拒绝。

CREATE TABLE `Id` (
  `id` VARCHAR(3000) PRIMARY KEY
)

length 参数允许您指定只有 id 值的一部分代表主键。在下面的示例中，使用了前 100 个字符

schema.prisma

model Id {
  id String @id(length: 100) @db.VarChar(3000)
}

如果在您的数据模型中指定了 length 参数，Prisma Migrate 能够创建具有此参数的约束和索引。这意味着您可以在 Prisma schema 类型为 Byte 和 String 的值上创建索引和约束。如果您未指定此参数，索引将像以前一样被视为覆盖完整值。

内省将获取现有数据库中存在的这些限制。这使得 Prisma ORM 能够支持以前被抑制的索引和约束，并更好地支持利用此特性的 MySQL 数据库。

length 参数也可以用于复合主键，使用 @@id 属性，如下面的示例所示

schema.prisma

model CompoundId {
  id_1 String @db.VarChar(3000)
  id_2 String @db.VarChar(3000)

  @@id([id_1(length: 100), id_2(length: 10)])
}

类似的语法可以用于 @@unique 和 @@index 属性。

使用 `sort` 配置索引排序顺序

sort 参数适用于 Prisma ORM 支持的所有数据库。它允许您指定索引或约束条目在数据库中的存储顺序。这可能会影响数据库是否能够使用索引来处理特定查询。

sort 参数适用于所有数据库的 @unique、@@unique 和 @@index。此外，SQL Server 也允许在 @id 和 @@id 上使用它。此功能在版本 4.0.0 及更高版本中普遍可用，并在版本 3.5.0 及更高版本中作为 extendedIndexes 预览特性的一部分提供。

例如，下表

CREATE TABLE `Unique` (
  `unique` INT,
  CONSTRAINT `Unique_unique_key` UNIQUE (`unique` DESC)
)

现在内省为

schema.prisma

model Unique {
  unique Int @unique(sort: Desc)
}

sort 参数也可以用于复合索引

schema.prisma

model CompoundUnique {
  unique_1 Int
  unique_2 Int

  @@unique([unique_1(sort: Desc), unique_2])
}

示例：同时使用 `sort` 和 `length`

以下示例演示了如何使用 sort 和 length 参数配置 Post 模型的索引和约束

schema.prisma

model Post {
  title      String   @db.VarChar(300)
  abstract   String   @db.VarChar(3000)
  slug       String   @unique(sort: Desc, length: 42) @db.VarChar(3000)
  author     String
  created_at DateTime

  @@id([title(length: 100, sort: Desc), abstract(length: 10)])
  @@index([author, created_at(sort: Desc)])
}

使用 `type` 配置索引访问类型 (PostgreSQL)

type 参数可用于在 PostgreSQL 中使用 @@index 属性配置索引类型。可用的索引访问方法包括 Hash、Gist、Gin、SpGist 和 Brin，以及默认的 BTree 索引访问方法。type 参数在版本 4.0.0 及更高版本中普遍可用。Hash 索引访问方法在版本 3.6.0 及更高版本中作为 extendedIndexes 预览特性的一部分提供，而 Gist、Gin、SpGist 和 Brin 索引访问方法在版本 3.14.0 及更高版本中以预览版提供。

Hash

Hash 类型将以一种搜索和插入速度更快、占用更少磁盘空间的格式存储索引数据。但是，只有 = 和 <> 比较可以使用此索引，因此对于 < 和 > 等其他比较运算符，使用 Hash 将比使用默认的 BTree 类型慢得多。

例如，以下模型为 value 字段添加了一个 type 为 Hash 的索引

schema.prisma

model Example {
  id    Int @id
  value Int

  @@index([value], type: Hash)
}

这将转换为以下 SQL 命令

CREATE TABLE "Example" (
  id INT PRIMARY KEY,
  value INT NOT NULL
);

CREATE INDEX "Example_value_idx" ON "Example" USING HASH (value);

广义倒排索引 (GIN)

GIN 索引存储复合值，例如数组或 JsonB 数据。这对于加快查询某个对象是否是另一个对象的一部分非常有用。它通常用于全文搜索。

索引字段可以定义操作符类（operator class），它定义了该索引处理的操作符。

警告

Prisma ORM 尚不支持使用函数（例如 to_tsvector）来确定索引值的索引。以这种方式定义的索引使用 prisma db pull 将不可见。

例如，以下模型为 value 字段添加了一个 Gin 索引，其中 JsonbPathOps 是允许使用此索引的操作符类

schema.prisma

model Example {
  id    Int  @id
  value Json
  //    ^ field type matching the operator class
  //                  ^ operator class      ^ index type

  @@index([value(ops: JsonbPathOps)], type: Gin)
}

这将转换为以下 SQL 命令

CREATE TABLE "Example" (
  id INT PRIMARY KEY,
  value JSONB NOT NULL
);

CREATE INDEX "Example_value_idx" ON "Example" USING GIN (value jsonb_path_ops);

作为 JsonbPathOps 的一部分，@> 操作符由该索引处理，从而加快了诸如 value @> '{"foo": 2}' 等查询。

支持的 GIN 操作符类

Prisma ORM 通常支持 PostgreSQL 10 及更高版本提供的操作符类。如果操作符类要求字段类型是 Prisma ORM 尚不支持的类型，则使用带有字符串输入的 raw 函数可以无需验证即可使用这些操作符类。

默认的操作符类（标有 ✅）可以从索引定义中省略。

操作符类	允许的字段类型 (原生类型)	默认	其他
`ArrayOps`	任意数组	✅	在 CockroachDB 中也可用
`JsonbOps`	`Json` (`@db.JsonB`)	✅	在 CockroachDB 中也可用
`JsonbPathOps`	`Json` (`@db.JsonB`)
`raw("other")`

在官方 PostgreSQL 文档中阅读更多关于内置操作符类的信息。

CockroachDB

CockroachDB 仅支持 GIN 和 BTree 索引类型。标记为与 CockroachDB 一起使用的操作符类是该数据库上唯一允许的，并且受到 Prisma ORM 的支持。操作符类不能在 Prisma Schema Language 中定义：ops 参数在 CockroachDB 上既非必需也不允许。

广义搜索树 (GiST)

GiST 索引类型用于实现用户定义类型的索引方案。默认情况下，GiST 索引没有太多直接用途，但例如 B-Tree 索引类型就是使用 GiST 索引构建的。

例如，以下模型为 value 字段添加了一个 Gist 索引，其中 InetOps 是将使用该索引的操作符

schema.prisma

model Example {
  id    Int    @id
  value String @db.Inet
  //           ^ native type matching the operator class
  //                                   ^ index type
  //                  ^ operator class

  @@index([value(ops: InetOps)], type: Gist)
}

这将转换为以下 SQL 命令

CREATE TABLE "Example" (
  id INT PRIMARY KEY,
  value INET NOT NULL
);

CREATE INDEX "Example_value_idx" ON "Example" USING GIST (value inet_ops);

比较 IP 地址的查询，例如 value > '10.0.0.2'，将使用此索引。

支持的 GiST 操作符类

操作符类	允许的字段类型 (允许的原生类型)
`InetOps`	`String` (`@db.Inet`)
`raw("other")`

在官方 PostgreSQL 文档中阅读更多关于内置操作符类的信息。

空间分区 GiST (SP-GiST)

SP-GiST 索引对于许多不同的非平衡数据结构来说是一个不错的选择。如果查询与分区规则匹配，其速度会非常快。

与 GiST 一样，SP-GiST 作为用户定义类型的重要构建块，允许直接在数据库中实现自定义搜索操作符。

例如，以下模型为 value 字段添加了一个 SpGist 索引，其中 TextOps 是使用该索引的操作符

schema.prisma

model Example {
  id    Int    @id
  value String
  //    ^ field type matching the operator class

  @@index([value], type: SpGist)
  //                     ^ index type
  //       ^ using the default ops: TextOps
}

这将转换为以下 SQL 命令

CREATE TABLE "Example" (
  id INT PRIMARY KEY,
  value TEXT NOT NULL
);

CREATE INDEX "Example_value_idx" ON "Example" USING SPGIST (value);

诸如 value LIKE 'something%' 的查询将通过该索引得到加速。

支持的 SP-GiST 操作符类

默认的操作符类（标有 ✅）可以从索引定义中省略。

操作符类	允许的字段类型 (原生类型)	默认	支持的 PostgreSQL 版本
`InetOps`	`String` (`@db.Inet`)	✅	10+
`TextOps`	`String` (`@db.Text`, `@db.VarChar`)	✅
`raw("other")`

在官方 PostgreSQL 文档中阅读更多关于内置操作符类的信息。

块范围索引 (BRIN)

BRIN 索引类型对于拥有大量插入后不更改的数据（例如日期和时间值）非常有用。如果您的数据非常适合该索引，它可以在最小的空间内存储大量数据集。

例如，以下模型为 value 字段添加了一个 Brin 索引，其中 Int4BloomOps 是将使用该索引的操作符

schema.prisma

model Example {
  id    Int @id
  value Int
  //    ^ field type matching the operator class
  //                  ^ operator class      ^ index type

  @@index([value(ops: Int4BloomOps)], type: Brin)
}

这将转换为以下 SQL 命令

CREATE TABLE "Example" (
  id INT PRIMARY KEY,
  value INT4 NOT NULL
);

CREATE INDEX "Example_value_idx" ON "Example" USING BRIN (value int4_bloom_ops);

像 value = 2 这样的查询现在将使用此索引，它只占用 BTree 或 Hash 索引所用空间的一小部分。

支持的 BRIN 操作符类

Prisma ORM 通常支持 PostgreSQL 10 及更高版本提供的操作符类，并且一些支持的操作符仅在 PostgreSQL 14 及更高版本中可用。如果操作符类要求字段类型是 Prisma ORM 尚不支持的类型，则使用带有字符串输入的 raw 函数可以无需验证即可使用这些操作符类。

默认的操作符类（标有 ✅）可以从索引定义中省略。

操作符类	允许的字段类型 (原生类型)	默认	支持的 PostgreSQL 版本
`BitMinMaxOps`	`String` (`@db.Bit`)	✅
`VarBitMinMaxOps`	`String` (`@db.VarBit`)	✅
`BpcharBloomOps`	`String` (`@db.Char`)		14+
`BpcharMinMaxOps`	`String` (`@db.Char`)	✅
`ByteaBloomOps`	`Bytes` (`@db.Bytea`)		14+
`ByteaMinMaxOps`	`Bytes` (`@db.Bytea`)	✅
`DateBloomOps`	`DateTime` (`@db.Date`)		14+
`DateMinMaxOps`	`DateTime` (`@db.Date`)	✅
`DateMinMaxMultiOps`	`DateTime` (`@db.Date`)		14+
`Float4BloomOps`	`Float` (`@db.Real`)		14+
`Float4MinMaxOps`	`Float` (`@db.Real`)	✅
`Float4MinMaxMultiOps`	`Float` (`@db.Real`)		14+
`Float8BloomOps`	`Float` (`@db.DoublePrecision`)		14+
`Float8MinMaxOps`	`Float` (`@db.DoublePrecision`)	✅
`Float8MinMaxMultiOps`	`Float` (`@db.DoublePrecision`)		14+
`InetInclusionOps`	`String` (`@db.Inet`)	✅	14+
`InetBloomOps`	`String` (`@db.Inet`)		14+
`InetMinMaxOps`	`String` (`@db.Inet`)
`InetMinMaxMultiOps`	`String` (`@db.Inet`)		14+
`Int2BloomOps`	`Int` (`@db.SmallInt`)		14+
`Int2MinMaxOps`	`Int` (`@db.SmallInt`)	✅
`Int2MinMaxMultiOps`	`Int` (`@db.SmallInt`)		14+
`Int4BloomOps`	`Int` (`@db.Integer`)		14+
`Int4MinMaxOps`	`Int` (`@db.Integer`)	✅
`Int4MinMaxMultiOps`	`Int` (`@db.Integer`)		14+
`Int8BloomOps`	`BigInt` (`@db.BigInt`)		14+
`Int8MinMaxOps`	`BigInt` (`@db.BigInt`)	✅
`Int8MinMaxMultiOps`	`BigInt` (`@db.BigInt`)		14+
`NumericBloomOps`	`Decimal` (`@db.Decimal`)		14+
`NumericMinMaxOps`	`Decimal` (`@db.Decimal`)	✅
`NumericMinMaxMultiOps`	`Decimal` (`@db.Decimal`)		14+
`OidBloomOps`	`Int` (`@db.Oid`)		14+
`OidMinMaxOps`	`Int` (`@db.Oid`)	✅
`OidMinMaxMultiOps`	`Int` (`@db.Oid`)		14+
`TextBloomOps`	`String` (`@db.Text`, `@db.VarChar`)		14+
`TextMinMaxOps`	`String` (`@db.Text`, `@db.VarChar`)	✅
`TextMinMaxMultiOps`	`String` (`@db.Text`, `@db.VarChar`)		14+
`TimestampBloomOps`	`DateTime` (`@db.Timestamp`)		14+
`TimestampMinMaxOps`	`DateTime` (`@db.Timestamp`)	✅
`TimestampMinMaxMultiOps`	`DateTime` (`@db.Timestamp`)		14+
`TimestampTzBloomOps`	`DateTime` (`@db.Timestamptz`)		14+
`TimestampTzMinMaxOps`	`DateTime` (`@db.Timestamptz`)	✅
`TimestampTzMinMaxMultiOps`	`DateTime` (`@db.Timestamptz`)		14+
`TimeBloomOps`	`DateTime` (`@db.Time`)		14+
`TimeMinMaxOps`	`DateTime` (`@db.Time`)	✅
`TimeMinMaxMultiOps`	`DateTime` (`@db.Time`)		14+
`TimeTzBloomOps`	`DateTime` (`@db.Timetz`)		14+
`TimeTzMinMaxOps`	`DateTime` (`@db.Timetz`)	✅
`TimeTzMinMaxMultiOps`	`DateTime` (`@db.Timetz`)		14+
`UuidBloomOps`	`String` (`@db.Uuid`)		14+
`UuidMinMaxOps`	`String` (`@db.Uuid`)	✅
`UuidMinMaxMultiOps`	`String` (`@db.Uuid`)		14+
`raw("other")`

在官方 PostgreSQL 文档中阅读更多关于内置操作符类的信息。

使用 `clustered` 配置索引是否聚集或非聚集 (SQL Server)

clustered 参数可用于在 SQL Server 中配置（非）聚集索引。它可以用于 @id、@@id、@unique、@@unique 和 @@index 属性。此功能在版本 4.0.0 及更高版本中普遍可用，并在版本 3.13.0 及更高版本中作为 extendedIndexes 预览特性的一部分提供。

例如，以下模型配置 @id 为非聚集（而不是默认的聚集）

schema.prisma

model Example {
  id    Int @id(clustered: false)
  value Int
}

这将转换为以下 SQL 命令

CREATE TABLE [Example] (
  id INT NOT NULL,
  value INT,
  CONSTRAINT [Example_pkey] PRIMARY KEY NONCLUSTERED (id)
)

每个属性的 clustered 默认值如下

属性	值
`@id`	`true`
`@@id`	`true`
`@unique`	`false`
`@@unique`	`false`
`@@index`	`false`

一个表最多只能有一个聚集索引。

从先前版本升级

警告

在为某些现有数据库的现有 Prisma schema 激活功能时，这些索引配置更改可能是重大更改。在启用使用它们所需的预览特性后，运行 prisma db pull 内省现有数据库以更新您的 Prisma schema，然后再使用 Prisma Migrate。

在以下情况下可能发生重大更改

现有排序约束和索引：较早版本的 Prisma ORM 在未显式指定顺序时，会假定所需的排序顺序是升序。这意味着如果您现有的约束或索引使用了降序，并且在数据模型中未首先指定此项就迁移数据库，则这是一个重大更改。
现有长度约束和索引：在较早版本的 Prisma ORM 中，MySQL 中受长度约束的索引和约束无法在 Prisma schema 中表示。因此，prisma db pull 未能获取这些信息，您也无法手动指定它们。当您运行 prisma db push 或 prisma migrate dev 时，如果它们已存在于您的数据库中，则会被忽略。由于您现在能够指定这些，如果它们在数据模型中缺失但在数据库中存在，迁移命令现在将删除它们。
现有非 BTree 索引 (PostgreSQL)：较早版本的 Prisma ORM 仅支持默认的 BTree 索引类型。其他支持的索引（Hash、Gist、Gin、SpGist 和 Brin）需要在迁移数据库之前添加。
现有（非）聚集索引 (SQL Server)：较早版本的 Prisma ORM 不支持将索引配置为聚集或非聚集。对于不使用默认设置的索引，需要在迁移数据库之前添加。

在上述每种情况下，都可以通过在数据模型中必要地正确指定这些属性来防止对数据库进行不必要的更改。最简单的方法是使用 prisma db pull 来检索任何现有的约束或配置。另外，您也可以手动添加这些参数。这应该在升级后首次使用 prisma db push 或 prisma migrate dev 之前完成。

全文索引 (MySQL 和 MongoDB)

fullTextIndex 预览特性在版本 3.6.0 及更高版本中提供了对 MySQL 和 MongoDB 中全文索引的内省和迁移的支持。这可以使用 @@fulltext 属性进行配置。数据库中现有的全文索引在通过 db pull 内省后会添加到您的 Prisma schema 中，而 Prisma schema 中新增的全文索引在使用 Prisma Migrate 时会在数据库中创建。这也解决了之前无法正常工作的某些数据库 schema 中的验证错误。

警告

目前，我们尚未在 Prisma Client for MongoDB 中启用全文搜索命令；进度可在 MongoDB issue 中跟踪。

启用 `fullTextIndex` 预览特性

要启用 fullTextIndex 预览特性，请将 fullTextIndex 特性标记添加到 schema.prisma 文件的 generator 块中

schema.prisma

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["fullTextIndex"]
}

示例

以下示例演示了如何为 Post 模型的 title 和 content 字段添加 @@fulltext 索引

schema.prisma

model Post {
  id      Int    @id
  title   String @db.VarChar(255)
  content String @db.Text

  @@fulltext([title, content])
}

在 MongoDB 中，您可以使用 @@fulltext 索引属性（通过 fullTextIndex 预览特性）和 sort 参数来将字段以升序或降序添加到全文索引中。以下示例为 Post 模型的 title 和 content 字段添加了一个 @@fulltext 索引，并按降序对 title 字段进行排序

schema.prisma

generator js {
  provider        = "prisma-client-js"
  previewFeatures = ["fullTextIndex"]
}

datasource db {
  provider = "mongodb"
  url      = env("DATABASE_URL")
}

model Post {
  id      String @id @map("_id") @db.ObjectId
  title   String
  content String

  @@fulltext([title(sort: Desc), content])
}

从先前版本升级

警告

在为某些现有数据库的现有 Prisma schema 激活功能时，这可能是重大更改。在启用使用它们所需的预览特性后，运行 prisma db pull 内省现有数据库以更新您的 Prisma schema，然后再使用 Prisma Migrate。

较早版本的 Prisma ORM 使用 @@index 属性而不是 @@fulltext 属性转换全文索引。启用 fullTextIndex 预览特性后，运行 prisma db pull 将这些索引转换为 @@fulltext，然后再使用 Prisma Migrate 进行迁移。如果您不这样做，现有索引将被删除，并在其位置创建普通索引。

索引配置​

使用 length 配置索引长度 (MySQL)​

使用 sort 配置索引排序顺序​

示例：同时使用 sort 和 length​

使用 type 配置索引访问类型 (PostgreSQL)​

Hash​

广义倒排索引 (GIN)​

支持的 GIN 操作符类​

CockroachDB​

广义搜索树 (GiST)​

支持的 GiST 操作符类​

空间分区 GiST (SP-GiST)​

支持的 SP-GiST 操作符类​

块范围索引 (BRIN)​

支持的 BRIN 操作符类​

使用 clustered 配置索引是否聚集或非聚集 (SQL Server)​

从先前版本升级​

全文索引 (MySQL 和 MongoDB)​

启用 fullTextIndex 预览特性​

示例​

从先前版本升级​

索引配置

使用 `length` 配置索引长度 (MySQL)

使用 `sort` 配置索引排序顺序

示例：同时使用 `sort` 和 `length`

使用 `type` 配置索引访问类型 (PostgreSQL)

Hash

广义倒排索引 (GIN)

支持的 GIN 操作符类

CockroachDB

广义搜索树 (GiST)

支持的 GiST 操作符类

空间分区 GiST (SP-GiST)

支持的 SP-GiST 操作符类

块范围索引 (BRIN)

支持的 BRIN 操作符类

使用 `clustered` 配置索引是否聚集或非聚集 (SQL Server)

从先前版本升级

全文索引 (MySQL 和 MongoDB)

启用 `fullTextIndex` 预览特性

示例

从先前版本升级