============== django-zombodb

.. image:: https://badge.fury.io/py/django-zombodb.svg :target: https://badge.fury.io/py/django-zombodb :alt: PyPI Status

.. image:: https://travis-ci.org/vintasoftware/django-zombodb.svg?branch=master :target: https://travis-ci.org/vintasoftware/django-zombodb :alt: Build Status

.. image:: https://readthedocs.org/projects/django-zombodb/badge/?version=latest :target: https://django-zombodb.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

.. image:: https://codecov.io/gh/vintasoftware/django-zombodb/branch/master/graph/badge.svg :target: https://codecov.io/gh/vintasoftware/django-zombodb :alt: Coverage Status

.. image:: https://img.shields.io/github/license/vintasoftware/django-zombodb.svg :alt: GitHub

Easy Django integration with Elasticsearch through ZomboDB <https://github.com/zombodb/zombodb>_ Postgres Extension. Thanks to ZomboDB, your Django models are synced with Elasticsearch at transaction time! 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

• Python: 3.5, 3.6, 3.7
• Django: 2.0, 2.1, 2.2
• Postgres and Elasticsearch: same as ZomboDB current requirements <https://github.com/zombodb/zombodb#system-requirements>_

Quickstart

1. Install ZomboDB (instructions here <https://github.com/zombodb/zombodb/blob/master/INSTALL.md>_)

2. Install django-zombodb:

::

pip install django-zombodb

3. Add the SearchQuerySet and the ZomboDBIndex to your model:

.. code-block:: python

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:

.. code-block:: python

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:

.. code-block:: python

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. Also, you need ZomboDB installed. Then just do:

::

python runtests.py

Security

Please check SECURITY.rst <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 <https://www.vinta.com.br/?django-zombodb=1>_ 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