django-zombodb 0.1.2

Documentation

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

Quickstart

1. Install ZomboDB (instructions here)

2. Install django-zombodb:

pip install django-zombodb

3. 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',
            ]),
        ]

4. Make the migrations:

python manage.py makemigrations

5. 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
    ]

6. Run the migrations (Postgres user must be SUPERUSER to create the ZomboDB extension):

python manage.py migrate

7. 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

Check https://github.com/vintasoftware/django-zombodb/tree/master/example

Running Tests

You need to have Elasticsearch and Postgres instances running on default ports. Then just do:

python runtests.py

Change Log

0.1.0 (2019-02-01)

• First release on PyPI.