stannum

stannum : Experimental TINQL text search with BM25 and segmented indexes

Overview

Packages

Source

pig build pkg stannum;		# build rpm/deb

Install

Make sure PGDG and PIGSTY repo available:

pig repo add pgsql -u   # add both repo and update cache

Install this extension with pig:

pig install stannum;		# install via package name, for the active PG version

pig install stannum -v 18;   # install for PG 18
pig install stannum -v 17;   # install for PG 17

Create this extension with:

CREATE EXTENSION stannum;

Usage

Sources:

• README
• Control file
• Cargo.toml
• postgres/sql/stannum–0.1.0.sql

stannum is an experimental text-search extension derived from Lead, with persistent indexes, Boolean and phrase queries, and BM25 scoring. The reviewed 0.1.0 source has its own extension identity and storage format.

Core Workflow

CREATE EXTENSION stannum;
CREATE TABLE documents (id bigint GENERATED ALWAYS AS IDENTITY PRIMARY KEY, body text);
INSERT INTO documents (body) VALUES
  ('PostgreSQL supports full text search'), ('Search with exact phrase matching');
CREATE INDEX documents_search ON documents USING stannum (body);
ANALYZE documents;
SELECT id, stannum.full_score(ctid) AS score
FROM documents WHERE body ==> 'search' ORDER BY score DESC LIMIT 10;
SELECT * FROM stannum.segment_info('documents_search');
SELECT * FROM stannum.verify_index('documents_search', heap_check => true);

Operation and Compatibility

The ==> operator accepts TINQL. stannum.highlight marks matching text; stannum.segment_info inspects index segments and stannum.verify_index checks their consistency, optionally against the heap. Index maintenance follows PostgreSQL writes and vacuum.

PostgreSQL 17 and 18 are build targets, with most current lifecycle evidence on 18. A superuser installs the extension in its fixed stannum schema. Primary-server use loads on demand. For standby index reads, add the library to shared_preload_libraries on both primary and standbys and restart those servers.

Migration Boundary

Do not install tin and stannum in the same database: their global ==> operator conflicts. There is no supported in-place migration from the earlier extension names or storage layouts. Treat this as experimental software and validate recovery and maintenance on the intended workload.