anysearch¶
AnySearch
is a Elasticsearch
and OpenSearch
compatibility library.
It provides utility functions for smoothing over the differences between the
Python libraries with the goal of writing Python code that is compatible on
both (including the *search
, *search-dsl
and django-*search-dsl
integration packages).
See the documentation for more information on what is provided.
Documentation¶
Documentation is available on Read the Docs.
Prerequisites¶
Python 3.6, 3.7, 3.8, 3.9 and 3.10.
Installation¶
Install latest stable version from PyPI:
pip install anysearch
or latest stable version from GitHub:
pip install https://github.com/barseghyanartur/anysearch/archive/main.tar.gz
Configuration¶
AnySearch
automatically detects whether you use Elasticsearch
or
OpenSearch
by looking at which packages are installed.
However, if you have both packages installed, you can instruct AnySearch
which one do you actually want to use. The way to do that is to set the
ANYSEARCH_PREFERRED_BACKEND
environment variable to either Elasticsearch
or OpenSearch
.
For Elasticsearch
:
import os
os.environ.setdefault("ANYSEARCH_PREFERRED_BACKEND", "Elasticsearch")
For OpenSearch
:
import os
os.environ.setdefault("ANYSEARCH_PREFERRED_BACKEND", "OpenSearch")
Usage¶
elasticsearch
/opensearch
¶
How-to¶
With elasticsearch
you would do:
from elasticsearch import Connection, Elasticsearch
With opensearch
you would do:
from opensearch_py import Connection, OpenSearch
With anysearch
you would change that to:
from anysearch.search import Connection, AnySearch
elasticsearch-dsl
/opensearch-dsl
¶
How-to¶
With elasticsearch-dsl
you would do:
from elasticsearch_dsl import AggsProxy, connections, Keyword
from elasticsearch_dsl.document import Document
With opensearch-dsl
you would do:
from opensearch_dsl import AggsProxy, connections, Keyword
from opensearch_dsl.document import Document
With anysearch
you would change that to:
from anysearch.search_dsl import AggsProxy, connections, Keyword
from anysearch.search_dsl.document import Document
django-elasticsearch-dsl
/django-opensearch-dsl
¶
How-to¶
With django-elasticsearch-dsl
you would do:
from django_elasticsearch_dsl import fields, registry
from django_elasticsearch_dsl.documents import Document
from django_elasticsearch_dsl.fields import TextField
With opensearch-dsl
you would do:
from django_opensearch_dsl import fields, registry
from django_opensearch_dsl.documents import Document
from django_opensearch_dsl.fields import TextField
With anysearch
you would change that to:
from anysearch.django_search_dsl import fields, registry
from anysearch.django_search_dsl.documents import Document
from anysearch.django_search_dsl.fields import TextField
Configuration¶
INSTALLED_APPS
¶
Both django-elasticsearch-dsl
and django-opensearch-dsl
will need to
be added to your INSTALLED_APPS
list.
With django-elasticsearch-dsl
you would do:
INSTALLED_APPS = (
...
"django_elasticsearch_dsl",
...
)
With django-opensearch-dsl
you would do:
INSTALLED_APPS = (
...
"django_opensearch_dsl",
...
)
With anysearch
you would change that to:
INSTALLED_APPS = (
...
"anysearch.django_search_dsl.DjangoAnySearchConfig",
...
)
Tuning¶
If you intent to support both Elasticsearch
and OpenSearch
, you could
specify your settings as follows:
# Elasticsearch configuration
ELASTICSEARCH_DSL = {
'default': {
'hosts': 'localhost:9200',
'timeout': 30,
},
}
OPENSEARCH_DSL = ELASTICSEARCH_DSL
ELASTICSEARCH_DSL_SIGNAL_PROCESSOR = "anysearch.django_search_dsl.RealTimeSignalProcessor"
OPENSEARCH_DSL_SIGNAL_PROCESSOR = ELASTICSEARCH_DSL_SIGNAL_PROCESSOR
Testing¶
Project is covered with tests.
To test with all supported Python versions type:
tox
To test against specific environment, type:
tox -e py39
To test just your working environment type:
pytest
To run a single test in your working environment type:
pytest test_anysearch.py
To run a single test class in a given test module in your working environment type:
pytest test_anysearch.py::DjangoSearchDSLTestCase
It’s assumed that you have either elasticsearch-dsl
or opensearch-dsl
installed. If not, install the requirements first.
Writing documentation¶
Keep the following hierarchy.
=====
title
=====
header
======
sub-header
----------
sub-sub-header
~~~~~~~~~~~~~~
sub-sub-sub-header
^^^^^^^^^^^^^^^^^^
sub-sub-sub-sub-header
++++++++++++++++++++++
sub-sub-sub-sub-sub-header
**************************
License¶
MIT
Support¶
For any security issues contact me at the e-mail given in the Author section. For overall issues, go to GitHub.
Documentation¶
Contents: