Skip to main content

Django elasticsearch integration.

Project description

This is Django application that helps intergrate Django with elasticsearch. It is built on top of elasticsearch-dsl.


3.x pypi MIT License


Project aims to support Python 3 and Django 1.8 (at least).

Quickstart

Configure your models to be indexable:

from django.db import models
from el.models import Indexed

class Article(models.Model, Indexed):
    title = models.CharField(max_length=78)

@classmethod
def get_indexable(cls):
    return cls.objects.all()

@classmethod
def configure_mapping(cls, mapping):
    # mapping is an elasticsearch_dsl Mapping object
    mapping.field('title', 'string')
    return mapping

Update search indexes:

./manage.py update_index

Use elasticsearch_dsl to query:

# articles is a list of an Article instances
articles = Article.search().query('match', title="Bob's article").execute()

Documentation

The library is in development, use it carefully, because until stable an API is a subject to change.

Project details


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