This release is a pre-release and may not be stable for production use.
plone.pgcatalog
PostgreSQL-backed catalog for Plone, replacing ZCatalog BTrees indexes with SQL queries on JSONB.
Requires zodb-pgjsonb as the ZODB storage backend.
Features
- All standard index types supported: FieldIndex, KeywordIndex, DateIndex, BooleanIndex, DateRangeIndex, UUIDIndex, ZCTextIndex, ExtendedPathIndex, GopipIndex
- DateRecurringIndex for recurring events (Plone's
start/endindexes) -- recurrence expansion at query time via rrule_plpgsql, no C extensions needed - Extensible via
IPGIndexTranslatornamed utilities for custom index types - Dynamic index discovery from ZCatalog at startup -- addons adding indexes via
catalog.xmljust work - Transactional writes -- catalog data written atomically alongside object state during ZODB commit
- Full-text search via PostgreSQL
tsvector/tsquery-- language-aware stemming for SearchableText (30 languages), word-level matching for Title/Description/addon ZCTextIndex fields - Optional BM25 ranking -- when
vchord_bm25+pg_tokenizerextensions are detected, search results are automatically ranked using BM25 (IDF, term saturation, length normalization) instead ofts_rank_cd. Title matches are boosted. Falls back to tsvector ranking on vanilla PostgreSQL. - Zero ZODB cache pressure -- no BTree/Bucket objects stored in ZODB
- Container-friendly -- works on standard
postgres:17Docker images; for BM25 usetensorchord/vchord-suite:pg17-latest
Requirements
- Python 3.12+
- PostgreSQL 15+ (tested with 17)
- zodb-pgjsonb
- Plone 6
Installation
pip install plone-pgcatalog
Add to your Zope configuration:
<!-- zope.conf -->
%import zodb_pgjsonb
<zodb_main>
<pgjsonb>
dsn dbname=mydb user=zodb password=zodb host=localhost port=5432
</pgjsonb>
</zodb_main>
Install the plone.pgcatalog:default GenericSetup profile through Plone's Add-on installer or your policy package.
Usage
Once installed, portal_catalog is replaced with PlonePGCatalogTool. All catalog queries use the same ZCatalog API:
# Standard catalog queries -- same syntax as ZCatalog
results = catalog(portal_type="Document", review_state="published")
results = catalog(Subject={"query": ["Python", "Plone"], "operator": "or"})
results = catalog(SearchableText="my search term")
results = catalog(SearchableText="Katzen", Language="de") # language-aware stemming
results = catalog(Title="quick fox") # word-level match (finds "The Quick Brown Fox")
results = catalog(path={"query": "/plone/folder", "depth": 1})
# Recurring events (DateRecurringIndex)
results = catalog(start={
"query": [DateTime("2025-03-01"), DateTime("2025-03-31")],
"range": "min:max",
})
Migrating an Existing Site
If you have a running Plone site and want to switch from ZCatalog to plone.pgcatalog:
Prerequisites: Your site must already be running on zodb-pgjsonb. If you're migrating from FileStorage or RelStorage, use zodb-convert first.
Steps:
-
Install plone-pgcatalog into your Python environment:
pip install plone-pgcatalog
-
Restart Zope (plone.pgcatalog is auto-discovered via
z3c.autoinclude). -
Install the
plone.pgcatalog:defaultGenericSetup profile -- either through the Plone Add-on control panel or programmatically:setup = portal.portal_setup setup.runAllImportStepsFromProfile("profile-plone.pgcatalog:default")
This replaces
portal_catalogwithPlonePGCatalogTool, preserving any addon-provided index definitions. -
Rebuild the catalog to populate PostgreSQL with all existing content:
catalog = portal.portal_catalog catalog.clearFindAndRebuild()
For a site with ~1000 documents, this takes about 15 seconds.
An automated migration script is included in example/scripts/migrate_to_pgcatalog.py
that performs all steps and verifies the result.
Using with plone.distribution
An example distribution package is included in example/pgcatalog-example-distribution/.
It registers a "Plone Site (PG Catalog)" distribution that appears in the site creation UI
and automatically applies the plone.pgcatalog:default profile.
To use plone.pgcatalog in your own distribution, add it to profiles.json:
{
"base": [
"plone.app.contenttypes:default",
"plonetheme.barceloneta:default",
"plone.pgcatalog:default"
]
}
Documentation
Rendered documentation: https://bluedynamics.github.io/plone-pgcatalog/
- Architecture -- design, index registry, query translation
- BENCHMARKS.md -- performance comparison vs RelStorage+ZCatalog
- CHANGES.md -- changelog
- example/ -- runnable example with multilingual content and an example distribution
Source Code and Contributions
The source code is managed in a Git repository, with its main branches hosted on GitHub. Issues can be reported there too.
We'd be happy to see many forks and pull requests to make this package even better. We welcome AI-assisted contributions, but expect every contributor to fully understand and be able to explain the code they submit. Please don't send bulk auto-generated pull requests.
Maintainers are Jens Klein and the BlueDynamics Alliance developer team. We appreciate any contribution and if a release on PyPI is needed, please just contact one of us. We also offer commercial support if any training, coaching, integration or adaptations are needed.
License
GPL-2.0
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file plone_pgcatalog-1.0.0b70.tar.gz.
File metadata
- Download URL: plone_pgcatalog-1.0.0b70.tar.gz
- Upload date:
- Size: 1.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
625826997865b60d779a236ec35bce6a0fcc2eb6c28700929606a4cb6a945f13
|
|
| MD5 |
1466f1688877280f28769c43d2a8454e
|
|
| BLAKE2b-256 |
ef80bc555eff492d9b6ea6140493ac126c07a3f671868c5b11ad36cf6c27086c
|
Provenance
The following attestation bundles were made for plone_pgcatalog-1.0.0b70.tar.gz:
Publisher:
release.yaml on bluedynamics/plone-pgcatalog
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
plone_pgcatalog-1.0.0b70.tar.gz -
Subject digest:
625826997865b60d779a236ec35bce6a0fcc2eb6c28700929606a4cb6a945f13 - Sigstore transparency entry: 2336269774
- Sigstore integration time:
-
Permalink:
bluedynamics/plone-pgcatalog@5bb057083fe5ad9fecdd36ca4281db66a123be24 -
Branch / Tag:
refs/tags/v1.0.0b70 - Owner: https://github.com/bluedynamics
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@5bb057083fe5ad9fecdd36ca4281db66a123be24 -
Trigger Event:
release
-
Statement type:
File details
Details for the file plone_pgcatalog-1.0.0b70-py3-none-any.whl.
File metadata
- Download URL: plone_pgcatalog-1.0.0b70-py3-none-any.whl
- Upload date:
- Size: 168.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7a62877ceb661e40b3e9dc926a7edbd0419ebcc3fe92de9fd9277968255b1096
|
|
| MD5 |
2655d993818c83eac96b0be0bd5d5edb
|
|
| BLAKE2b-256 |
616c013dd41bd35e6ea3b6f7496aed44be372b58d97c41ec3346ead42ea73e98
|
Provenance
The following attestation bundles were made for plone_pgcatalog-1.0.0b70-py3-none-any.whl:
Publisher:
release.yaml on bluedynamics/plone-pgcatalog
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
plone_pgcatalog-1.0.0b70-py3-none-any.whl -
Subject digest:
7a62877ceb661e40b3e9dc926a7edbd0419ebcc3fe92de9fd9277968255b1096 - Sigstore transparency entry: 2336269817
- Sigstore integration time:
-
Permalink:
bluedynamics/plone-pgcatalog@5bb057083fe5ad9fecdd36ca4281db66a123be24 -
Branch / Tag:
refs/tags/v1.0.0b70 - Owner: https://github.com/bluedynamics
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@5bb057083fe5ad9fecdd36ca4281db66a123be24 -
Trigger Event:
release
-
Statement type:
