Support order by relevance

Problem

Right now if you use full text search, the results are unordered. This wouldn’t be a very good search engine if it doesn’t order the results.

Suggested solution

Given the following Prisma Schema

// This is your Prisma schema file,
// learn more about it in the docs: https://pris.ly/d/prisma-schema

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

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

model Fruit {
  id Int @id @default(autoincrement())
  name String
}

Introduce a _relevance field, where you can order search fields by descending or ascending order .

  const results = await prisma.fruit.findMany({
    orderBy: {
      _relevance: {
        fields: ["name"],
        search: "Blue",
        sort: "desc",
      },
    },
  })

Note that we also support filtering search results:

  const results = await prisma.fruit.findMany({
    where: {
      name: {
        search: "Blue",
      },
    },
    orderBy: {
      _relevance: {
        fields: ["name"],
        search: "Blue",
        sort: "desc",
      },
    },
  })

These can be used together or separately.

• where filters the records (removes records with a relevance scores = 0),
• orderBy orders the record by their relevance score

Additional context

Implementation PRs:

• https://github.com/prisma/prisma-engines/pull/2203
• https://github.com/prisma/prisma/pull/9834
• https://github.com/prisma/prisma-client-go/pull/660

[abeaclark]

@janpio thanks for the tip! Working now!

[MichalLytek]

Ah right, my fault 😥 I had fullTextSearch in my experiment project, the tests for defaults (without flags) are passing. Sorry for the noise 😉