Skip to main content

Easy Django integration with Elasticsearch through ZomboDB Postgres Extension

Project description

PyPI Status Build Status Documentation Status Coverage Status GitHub

Easy Django integration with Elasticsearch through ZomboDB Postgres Extension. Thanks to ZomboDB, your Django models are synced with Elasticsearch after every transaction! Searching is also very simple: you can make Elasticsearch queries by just calling one of the search methods on your querysets. Couldn’t be easier!


The full documentation is at



  1. Install ZomboDB (instructions here)

  2. Install django-zombodb:

pip install django-zombodb
  1. Add the SearchQuerySet and the ZomboDBIndex to your model:

from django_zombodb.indexes import ZomboDBIndex
from django_zombodb.querysets import SearchQuerySet

class Restaurant(models.Model):
    name = models.TextField()

    objects = models.Manager.from_queryset(SearchQuerySet)()

    class Meta:
        indexes = [
  1. Make the migrations:

python makemigrations
  1. Add django_zombodb.operations.ZomboDBExtension() as the first operation of the migration you’ve just created:

import django_zombodb.operations

class Migration(migrations.Migration):

    dependencies = [
        ('restaurants', '0001_initial'),

    operations = [
        django_zombodb.operations.ZomboDBExtension(),  # <<< here
  1. Run the migrations (Postgres user must be SUPERUSER to create the ZomboDB extension):

python migrate
  1. Done! Now you can make Elasticsearch queries directly from your model:

Restaurant.objects.filter(is_open=True).query_string_search("brazil* AND coffee~")

Full Example


Running Tests

You need to have Elasticsearch and Postgres instances running on default ports. Also, you need ZomboDB installed. Then just do:



Please check SECURITY.rst. If you found or if you think you found a vulnerability please get in touch via admin AT

Please avoid disclosing any security issue on GitHub or any other public website. We’ll work to swiftly address any possible vulnerability and give credit to reporters (if wanted).

Commercial Support

This project is maintained by Vinta Software and other contributors. We are always looking for exciting work, so if you need any commercial support, feel free to get in touch:

Change Log

0.3.0 (2019-07-18)

  • Support for custom Elasticsearch mappings through field_mapping parameter on ZomboDBIndex.

  • Support to limit parameter on search methods.

0.2.1 (2019-06-13)

  • Dropped support for Python 3.4.

  • Added missing imports to docs.

0.2.0 (2019-03-01)

  • Removed parameter url from ZomboDBIndex. This simplifies the support of multiple deployment environments (local, staging, production), because the ElasticSearch URL isn’t copied to inside migrations code (see Issue #17).

0.1.0 (2019-02-01)

  • First release on PyPI.

Project details

Download files

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

Source Distribution

django-zombodb-0.3.0.tar.gz (12.8 kB view hashes)

Uploaded Source

Built Distribution

django_zombodb-0.3.0-py2.py3-none-any.whl (13.6 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page