pg_search

概览

bm25 am conflicts with pg_textsearch; PG15-16 require shared_preload_libraries while PG17-18 do not.

版本

构建

您可以使用 pig build 命令构建 pg_search 扩展的 DEB 包：

pig build pkg pg_search         # 构建 DEB 包

安装

您可以直接安装 pg_search 扩展包的预置二进制包，首先确保 PGDG 和 PIGSTY 仓库已经添加并启用：

pig repo add pgsql -u          # 添加仓库并更新缓存

使用 pig 或者是 apt/yum/dnf 安装扩展：

• 安装
• pig
• dnf
• apt

pig install pg_search;          # 当前活跃 PG 版本安装

pig ext install -y pg_search -v 18  # PG 18
pig ext install -y pg_search -v 17  # PG 17
pig ext install -y pg_search -v 16  # PG 16
pig ext install -y pg_search -v 15  # PG 15

dnf install -y pg_search_18       # PG 18
dnf install -y pg_search_17       # PG 17
dnf install -y pg_search_16       # PG 16
dnf install -y pg_search_15       # PG 15

apt install -y postgresql-18-pg-search   # PG 18
apt install -y postgresql-17-pg-search   # PG 17
apt install -y postgresql-16-pg-search   # PG 16
apt install -y postgresql-15-pg-search   # PG 15

预加载配置：

shared_preload_libraries = 'pg_search';

创建扩展：

CREATE EXTENSION pg_search;

用法

• 来源：ParadeDB extension install docs，quickstart，v0.23.0 release，pg_search README

pg_search 是 ParadeDB 提供的、基于 BM25 的 PostgreSQL 搜索扩展。上游 README 说明支持从 PostgreSQL 15 开始，而 v0.23.0 的自托管安装文档仍要求在 CREATE EXTENSION 之前先 preload 该库。

启用并创建扩展

shared_preload_libraries = 'pg_search'

CREATE EXTENSION pg_search;

v0.23.0 的自托管扩展文档说明提供了面向 Postgres 15+ 的预编译二进制包。

创建 BM25 索引

quickstart 示例使用 bm25 access method，并要求指定唯一键字段：

CREATE INDEX search_idx ON mock_items
USING bm25 (id, description, category, rating)
WITH (key_field = 'id');

v0.23.0 release 还提到，现在可以按字段调节 BM25 的 k1 和 b 参数。

查询操作符与辅助函数

当前 quickstart 使用以下查询操作符：

• |||：析取匹配，等价于 term1 OR term2。
• &&&：合取匹配，等价于 term1 AND term2。

示例：

SELECT description, rating
FROM mock_items
WHERE description ||| 'running shoes'
ORDER BY rating
LIMIT 5;

SELECT description, pdb.score(id)
FROM mock_items
WHERE description &&& 'running shoes'
ORDER BY score DESC
LIMIT 5;

SELECT description, pdb.snippet(description), pdb.score(id)
FROM mock_items
WHERE description ||| 'running shoes'
ORDER BY score DESC
LIMIT 5;

说明

开发分支 README 已把安装和用法细节指向官方文档站，而不是在 README 中内联维护 SQL 细节。因此，对当前 pg_search 语法而言，quickstart 才是最权威的用法来源；它反映的是 0.20 之后的 API，而不是一些次级资料里仍能看到的旧 @@@ 示例。