pg_search

ParadeDB BM25算法全文检索插件,ES全文检索

概览

扩展包名版本分类许可证语言
pg_search0.24.0FTSAGPL-3.0Rust
ID扩展名BinLibLoadCreateTrustReloc模式
2100pg_searchparadedb
相关扩展pgroonga pgroonga_database pg_bestmatch vchord_bm25 pg_bigm zhparser pg_tokenizer pg_trgm

bm25 am conflicts with pg_textsearch and vchord_bm25

版本

类型仓库版本PG 大版本包名依赖
EXTPIGSTY0.24.01817161514pg_search-
RPMPIGSTY0.24.01817161514pg_search_$v-
DEBPIGSTY0.24.01817161514postgresql-$v-pg-search-
OS / PGPG18PG17PG16PG15PG14
el8.x86_64PIGSTY MISS
el8.aarch64PIGSTY MISS
el9.x86_64PIGSTY MISS
el9.aarch64PIGSTY MISS
el10.x86_64PIGSTY MISS
el10.aarch64PIGSTY MISS
d12.x86_64
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.20.7
d12.aarch64
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.20.7
d13.x86_64
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.24.0
d13.aarch64
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.20.5
u22.x86_64
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.20.7
u22.aarch64
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.20.7
u24.x86_64
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.20.7
u24.aarch64
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.24.0
PIGSTY 0.20.7
u26.x86_64PIGSTY MISS
u26.aarch64PIGSTY MISS

构建

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

pig build pkg pg_search         # 构建 RPM / DEB 包

安装

您可以直接安装 pg_search 扩展包的预置二进制包,首先确保 PGDGPIGSTY 仓库已经添加并启用:

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

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

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 docscreate-index docsmatch docsscore docshighlight docsv0.24.0 releasepg_search README

pg_search 是 ParadeDB 为 PostgreSQL 提供的 BM25 搜索扩展。上游 README 说明支持从 PostgreSQL 15 开始;Pigsty 为 PostgreSQL 15-18 打包 0.24.0,并使用 cargo-pgrx 0.18.1 构建。

启用并创建扩展

shared_preload_libraries = 'pg_search'
CREATE EXTENSION pg_search;

自托管扩展文档要求在 CREATE EXTENSION 之前先设置 shared_preload_libraries = 'pg_search'

创建 BM25 索引

当前示例使用 bm25 access method,并指定唯一键字段:

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

每张表只支持一个 BM25 索引。key_field 是必填项,必须唯一,且必须是第一个被索引的列;文本类型 key fields 必须不分词。

查询操作符与辅助函数

当前文档使用以下查询操作符:

  • |||:析取匹配,等价于 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) AS score
FROM mock_items
WHERE description &&& 'running shoes'
ORDER BY score DESC
LIMIT 5;

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

常用结果辅助函数包括 pdb.score(id)pdb.snippet(field)pdb.snippets(field)pdb.snippet_positions(field)。高亮相对昂贵,且不支持 fuzzy search queries。

说明

  • 旧 quickstart URL 已移除;当前 |||&&&、scoring 和 highlighting 语法应以上方版本化文档页面为准。
  • Release 0.24.0 要求 preload pg_search,将 pgrx 升级到 0.18.1,并记录了 crash-recovery、ltree 与 inline-tokenizer 相关工作;上面的基础 BM25 查询示例没有变化。
  • Pigsty metadata 说明 bm25 access method 与 pg_textsearchvchord_bm25 冲突;未测试目标组合前,不要在同一集群中 preload 竞争性的 BM25 access-method 扩展。

最后修改 2026-06-18: extension data update (63e2bd9)