aboutsummaryrefslogtreecommitdiff
path: root/docs/elasticsearch.rst
diff options
context:
space:
mode:
authorArtur Smęt <artur.smet@mirumee.com>2017-01-25 12:16:03 +0100
committerArtur Smęt <artur.smet@mirumee.com>2017-01-25 14:28:46 +0100
commitb8f76228d7286f6037e30bb5a59b5e37d1a31774 (patch)
treed8dd0a38151ce0bfa6af731e279952e00902b4ca /docs/elasticsearch.rst
parentcba4ed10fd0b265571dd9b93a5005455e718f63e (diff)
downloadsaleor-frontend-b8f76228d7286f6037e30bb5a59b5e37d1a31774.tar.gz
saleor-frontend-b8f76228d7286f6037e30bb5a59b5e37d1a31774.tar.bz2
saleor-frontend-b8f76228d7286f6037e30bb5a59b5e37d1a31774.zip
Add docstrings and base description
Diffstat (limited to 'docs/elasticsearch.rst')
-rw-r--r--docs/elasticsearch.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/elasticsearch.rst b/docs/elasticsearch.rst
index bd5b259a..8b5ddf0c 100644
--- a/docs/elasticsearch.rst
+++ b/docs/elasticsearch.rst
@@ -45,3 +45,13 @@ Initial search index can be created with following command:
$ python manage.py update_index
By default products are reindexed after saving forms in the dashboard. Orders are updated after they're placed.
+
+
+Search integration architecture
+-------------------------------
+
+There are three base classes that are handling whole communication between Saleor and Elasticsearch service.
+
+* `ElasticsearchSearchBackend` - Core implementation of elasticsearch communication. Here is the starting point of any search queries.
+* `ElasticsearchSearchQuery` - Abstration for queries passed to elasticsearch. Any filtering or aggregations should be implemented there.
+* `ElasticsearchSearchResults` - Abstration for search results