repoze.pgtextindex 1.1

Text index for repoze.catalog based on PostgreSQL 8.4
repoze.pgtextindex is a repoze.catalog indexing plugin that provides a text search engine based on the powerful text indexing capabilities of PostgreSQL 8.4 and above. It is designed to take the place of any text search index based on zope.index. Installation typically requires few or no changes to code that already uses repoze.catalog.

The advantages of repoze.pgtextindex over zope.index.text include:

 * Performance. For large datasets, repoze.pgtextindex can be orders of magnitude faster than zope.index, mainly because repoze.pgtextindex does not have the overhead of unpickling objects that zope.index has.
 * Lower RAM consumption. Users of zope.index work around the unpickling overhead by keeping large caches of unpickled objects in RAM. Even worse, each thread keeps its own copy of the object cache. PostgreSQL, on the other hand, does not need to maintain complex structures in RAM. The PostgreSQL process size tends to be constant and reasonable.
 * Maintenance. The text indexing features of PostgreSQL are well documented and receive a great deal of active maintenance, while zope.index has not received much developer attention for years.

repoze.pgtextindex does not cause PostgreSQL to be involved in every catalog query and update. Only operations that use or change the text index hit PostgreSQL.


repoze.pgtextindex is used just like any other index in repoze.catalog:

from repoze.pgtextindex import PGTextIndex

index = PGTextIndex(

The arguments to the constructor are as follows:

 The repoze.catalog discrminator for this index. For more information on discrminators see the repoze.catalog documentation. This argument is required.
 The connection string for connecting to PostgreSQL. This argument is required.
 The table to use for the index. The default is 'pgtextindex'.
 The PostgreSQL text search configuration to use for the index. The default is 'english' which is the default built in configuration which ships with PostgreSQL. For more information on text search configuration, see the PostgreSQL full text search documentation.
 If True the table and index used will dropped (if it exists) and (re)created. The default is True.

last updated on:
September 9th, 2012, 16:03 GMT
license type:
BSD License 
developed by:
Shane Hathaway
ROOT \ Database \ Database APIs
Download Button

In a hurry? Add it to your Download Basket!

user rating



Rate it!
What's New in This Release:
  • Handle concurrent index updates cleanly.
read full changelog

Add your review!