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!

Documentation

The full documentation is at https://django-zombodb.readthedocs.io.

Requirements

Quickstart

  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 = [
            ZomboDBIndex(fields=[
                'name',
            ]),
        ]
  1. Make the migrations:
python manage.py 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 manage.py 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~")

Running Tests

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

python runtests.py

Security

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

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: contact@vinta.com.br

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.

Files for django-zombodb, version 0.3.0
Filename, size & hash File type Python version Upload date
django_zombodb-0.3.0-py2.py3-none-any.whl (13.6 kB) View hashes Wheel 3.7
django-zombodb-0.3.0.tar.gz (12.8 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page