Skip to main content

Implementation of PostgreSQL Full Text Search for django 1.7

Project description


Implementation PostgeSQL for Full Text Search for django 1.7, taking advantage of new features Migrations and Custom Lookups.


- FieldLookup's search, isearch, tsquery

- Ranking support with normalization, and weights using annotations

- Migrations classes to help create and remove index's, support for 'gin' or 'gist'

- Migrations classes to help create and remove of trigger's

- Multiple dictionaries support with trigger and FieldLookup's

- Support for python 2.7, 3.3 and 3.4

With multiple dictionary support, index and trigger migrations

How it works

For a existing model::

class Article(models.Model):
title = models.CharField(max_length=255)
article = models.TextField()

You want to have full text search in fields title and article, and make give weight to title of 'A'.

Import TSVectorField::

from pg_fts.fields import TSVectorField

Add to existing TSVectorField to model and tell the fields that you want to index and the dictionary::

fts = TSVectorField(fields=(('title', 'A'), 'article'), dictionary='english')

Create migrations file::

python makemigrations article

Open the new created migration and import CreateFTSIndexOperation, CreateFTSTriggerOperation, UpdateVectorOperation::

from pg_fts.migrations import (CreateFTSIndexOperation, CreateFTSTriggerOperation,

And add to the end of operations::

# update vector for already existing data
# create trigger for automatic insert and update vector
# create gin index for vector

Make the changes to your database::

python migrate article

Now you have a full text search performance with a trigger that checks any changes in the tracked fields and updates vector field.

You can search will match all words:

>>> Article.objects.filter(fts__search='waz up')

Will result in sql something like:

.. code-block:: sql

tsvector @@ to_tsquery('english', 'waz & up')

Or isearch will match some words:

>>> Article.objects.filter(fts__isearch='waz up')

Will result in sql something like:

.. code-block:: sql

tsvector @@ to_tsquery('english', 'waz | up')

But you can make a raw tsquery:

>>> Article.objects.filter(fts__tsquery='waz & !up')

Will result in sql something like:

.. code-block:: sql

tsvector @@ to_tsquery('english', 'waz & !up')

And also rank the results with normalization and order:

>>> from pg_fts.ranks import FTSRank
>>> Article.objects.filter(
rank=FTSRank(fts_search='waz up', normalization=[1,3])).order_by('-rank')

For multiple dictionaries and more advanced options, check the `documentation <>`_.


Documentation available in `Read The Docs <>`_


Clone from GitHub::

git clone git:// django-pg-fts

You should run the tests::


Or running tox for py27, py33, py34::


Install using pip from github::

pip install git+

Or using


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-pg-fts, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size django_pg_fts-0.1.1-py2.py3-none-any.whl (14.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size django-pg_fts-0.1.1.tar.gz (28.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page