Skip to main content

Elasticsearch data layer for eve rest framework

Project description


.. image::

Eve-Elastic is `elasticsearch <>`_ data layer for `eve REST framework <>`_.


- fulltext search
- filtering via elasticsearch filter dsl
- facets support
- elasticsearch mapping generator for schema

Eve-Elastic is `GPLv3 <>`_ licensed.


.. code-block:: bash

$ pip install Eve-Elastic

Set elastic as your eve data layer.

.. code-block:: python

import eve
form eve_elastic import Elastic

app = eve.Eve(data=Elastic)

There are 2 options for Eve-Elastic taken from ``app.config``:

- ``ELASTICSEARCH_URL`` (default: ``'http://localhost:9200/'``)
- ``ELASTICSEARCH_INDEX`` - (default: ``'eve'``)

Filter DSL
For more sophisticated filtering, you can use ``filter`` query param which will be used as filter for the query, using elastic `filter dsl <>`_.

To add a facets support for specific resource, add ``facets`` into its ``datasource``:

.. code-block:: python

'contacts': {
'facets': {
'urgency': {'terms': {'field': 'urgency'}},
'versioncreated': {'date_histogram': {'field': 'versioncreated', 'interval': 'hour'}}

You will find `more info about facets in elasticsearch docs <>`_.

.. :changelog:


0.1.3 (2014-01-31)

- Allow filtering via elasticsearch filter dsl

0.1.2 (2014-01-30)

- Fix pip install (add missing MANIFEST file)

0.1.1 (2014-01-30)

- Add changelog ;)
- Migrate readme to rst and use it for ``long_description``

0.1.0 (2014-01-28)

- Initial release

Project details

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for Eve-Elastic, version 0.1.3b2
Filename, size File type Python version Upload date Hashes
Filename, size Eve-Elastic-0.1.3b2.tar.gz (41.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page