Django Simple Elasticsearch¶
This package provides a simple method of creating Elasticsearch indexes for Django models.
Using a version older than 0.9.0? Please be aware that as of v0.9.0, this package has changed in a backwards-incompatible manner. Version 0.5 is deprecated and no longer maintained.
Documentation¶
Visit the django-simple-elasticsearch documentation on ReadTheDocs.
Features¶
- class mixin with a set of
@classmethods
used to handle:
- type mapping definition
- individual object indexing and deletion
- bulk object indexing
- model signal handlers for pre/post_save and pre/post_delete (optional)
- management command to handle index/type mapping initialization and bulk indexing
- uses Elasticsearch aliases to ease the burden of re-indexing
- small set of Django classes and functions to help deal with Elasticsearch querying
- base search form class to handle input validation, query preparation and response handling
- multi-search processor class to batch multiple Elasticsearch queries via
_msearch
- ‘get’ shortcut functions
- post index create/rebuild signals available to perform actions after certain stages (ie. add your own percolators)
Installation¶
At the command line:
$ easy_install django-simple-elasticsearch
Or:
$ pip install django-simple-elasticsearch
License¶
django-simple-elasticsearch is licensed as free software under the BSD license.
Todo¶
- Review search classes - simplify functionality where possible. This may cause breaking changes.
- Tests. Write them.
- Documentation. Write it.
Jump to a section¶
- Usage
- Contributing
- Credits
- History
- 1.0.0 (2016-12-20)
- 0.9.16 (2015-04-24)
- 0.9.15 (2015-01-31)
- 0.9.14 (2015-01-31)
- 0.9.13 (2015-01-30)
- 0.9.12 (2014-12-17)
- 0.9.11 (2014-12-08)
- 0.9.10 (2014-12-04)
- 0.9.9 (2014-11-24)
- 0.9.8 (2014-11-23)
- 0.9.7 (2014-11-16)
- 0.9.6 (2014-11-16)
- 0.9.5 (2014-11-15)
- 0.9.2 (2014-11-12)
- 0.9.1 (2014-11-10)
- 0.9.0 (2014-11-10)
- 0.5.0 (2014-03-05)