https://github.com/django-es/django-elasticsearch-dsl

This is a package that allows indexing of django models in elasticsearch with elasticsearch-dsl-py.
https://github.com/django-es/django-elasticsearch-dsl

elasticsearch hacktoberfest

Last synced: 2 days ago
JSON representation

This is a package that allows indexing of django models in elasticsearch with elasticsearch-dsl-py.

• Host: GitHub
• URL: https://github.com/django-es/django-elasticsearch-dsl
• Owner: django-es
• License: other
• Created: 2016-08-22T16:48:44.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-10-09T03:20:54.000Z (4 months ago)
• Last Synced: 2025-01-16T17:19:51.880Z (9 days ago)
• Topics: elasticsearch, hacktoberfest
• Language: Python
• Homepage:
• Size: 327 KB
• Stars: 1,034
• Watchers: 39
• Forks: 264
• Open Issues: 135
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

• awesome-django - django-elasticsearch-dsl - Elasticsearch DSL integration for Django. (Third-Party Packages / Search)

README

        
========================

Django Elasticsearch DSL

========================

.. image:: https://github.com/django-es/django-elasticsearch-dsl/actions/workflows/ci.yml/badge.svg

    :target: https://github.com/django-es/django-elasticsearch-dsl/actions/workflows/ci.yml

.. image:: https://codecov.io/gh/django-es/django-elasticsearch-dsl/coverage.svg?branch=master

    :target: https://codecov.io/gh/django-es/django-elasticsearch-dsl

.. image:: https://badge.fury.io/py/django-elasticsearch-dsl.svg

    :target: https://pypi.python.org/pypi/django-elasticsearch-dsl

.. image:: https://readthedocs.org/projects/django-elasticsearch-dsl/badge/?version=latest&style=flat

    :target: https://django-elasticsearch-dsl.readthedocs.io/en/latest/

Django Elasticsearch DSL is a package that allows indexing of django models in elasticsearch.

It is built as a thin wrapper around elasticsearch-dsl-py_

so you can use all the features developed by the elasticsearch-dsl-py team.

You can view the full documentation at https://django-elasticsearch-dsl.readthedocs.io

.. _elasticsearch-dsl-py: https://github.com/elastic/elasticsearch-dsl-py

Features

--------

- Based on elasticsearch-dsl-py_ so you can make queries with the Search_ class.

- Django signal receivers on save and delete for keeping Elasticsearch in sync.

- Management commands for creating, deleting, rebuilding and populating indices.

- Elasticsearch auto mapping from django models fields.

- Complex field type support (ObjectField, NestedField).

- Index fast using `parallel` indexing.

- Requirements

   - Django >= 3.2

   - Python 3.8, 3.9, 3.10, 3.11

**Elasticsearch Compatibility:**

The library is compatible with all Elasticsearch versions since 5.x

**but you have to use a matching major version:**

- For Elasticsearch 8.0 and later, use the major version 8 (8.x.y) of the library.

- For Elasticsearch 7.0 and later, use the major version 7 (7.x.y) of the library.

- For Elasticsearch 6.0 and later, use the major version 6 (6.x.y) of the library.

.. code-block:: python

    # Elasticsearch 8.x

    elasticsearch-dsl>=8.0.0,<9.0.0

    # Elasticsearch 7.x

    elasticsearch-dsl>=7.0.0,<8.0.0

    # Elasticsearch 6.x

    elasticsearch-dsl>=6.0.0,<7.0.0

.. _Search: http://elasticsearch-dsl.readthedocs.io/en/stable/search_dsl.html