全文搜索

Prisma Client 支持 2.30.0 及更高版本的 **PostgreSQL** 数据库和 3.8.0 及更高版本的 **MySQL** 数据库的全文搜索。启用全文搜索 (FTS) 后，可以通过搜索数据库列中的文本，为你的应用程序添加搜索功能。

信息

在 Prisma v6 中，FTS 已 在 MySQL 上提升至通用可用性。对于 PostgreSQL，它仍然处于预览阶段，需要使用 fullTextSearchPostgres 预览功能标志。

为 PostgreSQL 启用全文搜索

全文搜索 API 目前是预览功能。要启用此功能，请执行以下步骤

1. 更新模式中的 previewFeatures 块，以包含 fullTextSearchPostgres 预览功能标志

   schema.prisma

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

2. 生成 Prisma Client

   npx prisma generate

重新生成客户端后，在模型上创建的任何 String 字段上都将提供一个新的 search 字段。例如，以下搜索将返回所有包含“cat”一词的帖子。

// All posts that contain the word 'cat'.
const result = await prisma.posts.findMany({
  where: {
    body: {
      search: 'cat',
    },
  },
})

**注意**：PostgreSQL 的全文搜索功能目前存在一个 已知问题。如果观察到搜索查询速度缓慢，则可以使用 使用原始 SQL 优化你的查询。

查询数据库

search 字段在幕后使用数据库的原生查询功能。这意味着可用的精确查询运算符也特定于数据库。

PostgreSQL

以下示例演示了 PostgreSQL 'and' (&) 和 'or' (|) 运算符的使用

// All posts that contain the words 'cat' or 'dog'.
const result = await prisma.posts.findMany({
  where: {
    body: {
      search: 'cat | dog',
    },
  },
})

// All drafts that contain the words 'cat' and 'dog'.
const result = await prisma.posts.findMany({
  where: {
    status: 'Draft',
    body: {
      search: 'cat & dog',
    },
  },
})

为了了解查询格式的工作原理，请考虑以下文本

"The quick brown fox jumps over the lazy dog"

以下是以下查询将如何匹配该文本

查询	匹配？	说明
fox & dog	是	文本包含“fox”和“dog”
dog & fox	是	文本包含“dog”和“fox”
dog & cat	否	文本包含“dog”但不包含“cat”
!cat	是	文本中不包含“cat”
fox | cat	是	文本包含“fox”或“cat”
cat | pig	否	文本不包含“cat”或“pig”
fox <-> dog	是	文本中“dog”位于“fox”之后
dog <-> fox	否	文本中“fox”不位于“dog”之后

有关支持的操作的完整范围，请参阅 PostgreSQL 全文搜索文档。

MySQL

以下示例演示了 MySQL 'and' (+) 和 'not' (-) 运算符的使用

// All posts that contain the words 'cat' or 'dog'.
const result = await prisma.posts.findMany({
  where: {
    body: {
      search: 'cat dog',
    },
  },
})

// All posts that contain the words 'cat' and not 'dog'.
const result = await prisma.posts.findMany({
  where: {
    body: {
      search: '+cat -dog',
    },
  },
})

// All drafts that contain the words 'cat' and 'dog'.
const result = await prisma.posts.findMany({
  where: {
    status: 'Draft',
    body: {
      search: '+cat +dog',
    },
  },
})

为了了解查询格式的工作原理，请考虑以下文本

"The quick brown fox jumps over the lazy dog"

以下是以下查询将如何匹配该文本

查询	匹配？	描述
+fox +dog	是	文本包含“fox”和“dog”
+dog +fox	是	文本包含“dog”和“fox”
+dog -cat	是	文本包含“dog”但不包含“cat”
-cat	否	减号运算符不能单独使用（见下文说明）
fox dog	是	文本包含“fox”或“dog”
quic*	是	文本包含以“quic”开头的单词
quick fox @2	是	“fox”的起始位置与“quick”的起始位置相隔 2 个单词
fox dog @2	否	“dog”的起始位置与“fox”的起始位置相隔不超过 2 个单词
"jumps over"	是	文本包含整个短语“jumps over”

**注意**：减号运算符仅用于排除其他搜索词匹配的行。因此，仅包含以减号开头的词的布尔模式搜索将返回空结果。它不会返回“除了包含任何排除项的行之外的所有行”。

MySQL 还具有 >、< 和 ~ 运算符，用于更改搜索结果的排名顺序。例如，考虑以下两条记录

1. "The quick brown fox jumps over the lazy dog"

2. "The quick brown fox jumps over the lazy cat"

查询	结果	描述
fox ~cat	先返回 1，然后返回 2。	返回所有包含“fox”的记录，但将包含“cat”的记录排名降低
fox (<cat >dog)	先返回 1，然后返回 2。	返回所有包含“fox”的记录，但将包含“cat”的记录排名低于包含“dog”的行

有关支持的操作的完整范围，请参阅 MySQL 全文搜索文档。

按 _relevance 排序结果

警告

仅 PostgreSQL 和 MySQL 支持按相关性排序。

除了 Prisma Client 的默认 orderBy 行为 之外，全文搜索还添加了按给定字符串或字符串的相关性排序的功能。例如，如果要按帖子标题中“database”一词的相关性对帖子进行排序，可以使用以下方法

const posts = await prisma.post.findMany({
  orderBy: {
    _relevance: {
      fields: ['title'],
      search: 'database',
      sort: 'asc'
    },
  },
})

添加索引

PostgreSQL

Prisma Client 目前不支持使用索引来加速全文搜索。为此有一个现有的 GitHub Issue。

MySQL

对于 MySQL，需要在使用 @@fulltext 参数在 schema.prisma 文件中搜索的任何列中添加索引。

在以下示例中，一个全文索引添加到 Blog 模型的 content 字段，另一个索引同时添加到 content 和 title 字段。

schema.prisma

generator client {
  provider        = "prisma-client-js"
}

model Blog {
  id      Int    @unique
  content String
  title   String

  @@fulltext([content])
  @@fulltext([content, title])
}

第一个索引允许搜索 content 字段中“cat”一词的出现情况。

const result = await prisma.blogs.findMany({
  where: {
    content: {
      search: 'cat',
    },
  },
})

第二个索引允许同时搜索 content 和 title 字段中“cat”一词在 content 中的出现情况和“food”一词在 title 中的出现情况。

const result = await prisma.blogs.findMany({
  where: {
    content: {
      search: 'cat',
    },
    title: {
      search: 'food',
    },
  },
})

但是，如果您尝试仅根据title进行搜索，搜索将失败并出现错误“找不到用于搜索的全文索引”，并且消息代码为P2030，因为搜索需要这两个字段上的索引。

使用原始 SQL 进行全文搜索

全文搜索目前处于预览阶段，并且由于已知问题，您可能会遇到搜索查询缓慢的问题。如果是这样，您可以使用TypedSQL优化您的查询。

PostgreSQL

使用TypedSQL，您可以使用 PostgreSQL 的to_tsvector和to_tsquery来表达您的搜索查询。

fullTextSearch.sql

SELECT * FROM "Blog" WHERE to_tsvector('english', "Blog"."content") @@ to_tsquery('english', ${term});

index.ts

import { fullTextSearch } from "@prisma/client/sql"

const term = `cat`
const result = await prisma.$queryRawTyped(fullTextSearch(term))

注意：根据您的语言偏好，您可以在 SQL 语句中将english替换为其他语言。

如果您想在搜索词中包含通配符，您可以按如下方式操作

fullTextSearch.sql

SELECT * FROM "Blog" WHERE to_tsvector('english', "Blog"."content") @@ to_tsquery('english', ${term});

index.ts

const term = `cat:*`
const result = await prisma.$queryRawTyped(fullTextSearch(term))

MySQL

在 MySQL 中，您可以按如下方式表达您的搜索查询

fullTextSearch.sql

SELECT * FROM Blog WHERE MATCH(content) AGAINST(${term} IN NATURAL LANGUAGE MODE);

index.ts

const term = `cat`
const result = await prisma.$queryRawTyped(fullTextSearch(term))