django-opensearch-dsl
Advanced tools
Django Opensearch DSL is a package that allows the indexing of Django models in opensearch. It is built as a thin
wrapper around opensearch-py
so you can use all the features developed by the opensearch-py team.
You can view the full documentation at https://django-opensearch-dsl.readthedocs.io.
opensearch-py so you can make queries with
the Search
object.ObjectField, NestedField).parallel indexing.django-opensearch-dsl only support the supported version of each dependency (mainstream & lts).
Python (supported versions)Django (supported versions)opensearch-py (compatibility matrix)The easiest way to install django-opensearch-dsl is through pip:
pip install django-opensearch-dslThen add django_opensearch_dsl to your INSTALLED_APPS settings.
You must then define OPENSEARCH_DSL in your Django settings.
For example:
OPENSEARCH_DSL = {
'default': {
'hosts': 'localhost:9200'
},
'secure': {
'hosts': [{"scheme": "https", "host": "192.30.255.112", "port": 9201}],
'http_auth': ("admin", "password"),
'timeout': 120,
},
}
OPENSEARCH_DSL is then passed
to opensearchpy.connection.connections.configure
.
To index instances of the following model :
# models.py
class Car(models.Model):
name = models.CharField()
color = models.CharField()
description = models.TextField()
type = models.IntegerField(choices=[
(1, "Sedan"),
(2, "Truck"),
(4, "SUV"),
])
First create a subclass of django_opensearch_dsl.Document containing the subclasses Index
(which define the index' settings) and Django (which contains settings related to your django Model). Finally,
register the class using registry.register_document() decorator.
It is required to define Document classes inside a file named documents.py in your apps' directory.
# documents.py
from django_opensearch_dsl import Document
from django_opensearch_dsl.registries import registry
from .models import Car
@registry.register_document
class CarDocument(Document):
class Index:
name = 'cars' # Name of the Opensearch index
settings = { # See Opensearch Indices API reference for available settings
'number_of_shards': 1,
'number_of_replicas': 0
}
# Configure how the index should be refreshed after an update.
# See Opensearch documentation for supported options.
# This per-Document setting overrides settings.OPENSEARCH_DSL_AUTO_REFRESH.
auto_refresh = False
class Django:
model = Car # The model associated with this Document
fields = [ # The fields of the model you want to be indexed in Opensearch
'name',
'color',
'description',
'type',
]
# Paginate the django queryset used to populate the index with the specified size
# This per-Document setting overrides settings.OPENSEARCH_DSL_QUERYSET_PAGINATION.
queryset_pagination = 5000
CelerySignalProcessor previously using RealTimeSignalProcessor's method due to wrong indentation (#66),
Contributed by jlariza.models.PositiveBigIntegerField is now automatically mapped to LongField (#67), Contributed by jlariza.CelerySignalProcessor (#62),
Contributed by Jordan Hyatt and jlariza.
.delay when calling tasks.mananage.py opensearch index update subcommand to update an existing index mappings (#52).CelerySignalProcessor as an alternative to RealTimeSignalProcessor to process signals asynchronously using Celery
(#51).registry.get_models() and registry.__contains__() methods (#48, Contributed by ghkdxofla - Taelim Hwang (Limy)).opensearch command, any error now displays the raw OpenSearch response (#49).isort and
bandit to CI (#50).field_value_to_ignore=None to django_opensearch_dsl.fields.ListField.get_value_from_instance
(#47,
Contributed by ghkdxofla - Taelim Hwang (Limy)).opensearch-dsl-py to opensearch-py.opensearch-dsl-py project. Its features are now directly
included in opensearch-py.get_indexing_queryset() now order unordered QuerySet by their PK.
(#29, Contributed by Cédric Raud).keep_order argument of django_opensearch_dsl.search.Search.to_queryset now default to True
to be in line with the documentation (#27).Document.update() method now take an optional using argument allowing to specify an alternate
OpenSearch connection defined in OPENSEARCH_DSL.pre-delete back into BaseSignalProcessor.handle_m2m_changed() to properly update the
index on M2M interactions (Contributed by Colin Seifer).django-opensearch-dsl now only tests supported version of Python and Django (mainstream and LTS).
This choice is made to:
opensearch-dsl>=2.0 <3.00.TESTING boolean in settings.py.search_index management command with opensearch.search_index management command with opensearch.django-elasticsearch-dslDecimalField #141parallel indexing. #213. Now you can pass --parallel or set ELASTICSEARCH_DSL_PARALLEL
in your settings to get indexing speed boost while indexing through management command.standard token filter from README.md and test filesDocType import has changed to DocumentMeta has changed to class Django (See PR #136)register_document decorator to register a document (See PR #136)FAQs
Wrapper around opensearch-py for django models
We found that django-opensearch-dsl demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.