Pure Postgresql search backend for Django Oscar
Project description
Postgresql search handler for Django-Oscar
This creates a search handler without the need of any search backend. It is designed for the e-commerce framework Oscar.
It is implemented a little bit expensive but uses 4 annotated search vectors: * upc * title * meta_description * meta_title
This way the search can be manipulated through the meta fields. It is running productive in a heavily customized env for many months now. I think it should scale up to 5000 Products with 10 Attributes depending on how the products are loaded. We use it fully lazy with endless scrolling.
To-Do
- Provide a generic way to use filter forms
- Writing Tests
Features
- Don't need to use some additional search backend like elastic
- Creates filters (facets) for:
- Data that is directly attached to the Product model
- including foreign key choices
- AttributeValues of the products
- StockRecord entries
Installation
Basic
Install using pip:
pip install django-oscar-pg-search
# settings.py
# replace 'oscar.apps.search.apps.SearchConfig' by 'oscar_pg_search.apps.PgSearchConfig'
INSTALLED_APPS = [
# 'oscar.apps.search.apps.SearchConfig',
'oscar_pg_search.apps.PgSearchConfig',
]
OSCAR_PRODUCT_SEARCH_HANDLER = 'oscar_pg_search.postgres_search_handler.PostgresSearchHandler'
# To avoid exception, haystack is not used:
HAYSTACK_CONNECTIONS = {"default": {}}
Trigram search is our search algorithm. Enable it at your database by executing the following sql:
CREATE EXTENSION pg_trgm;
Optional Search box
To install the included Search box that passes the previous search term. (eg. in 'oscar/partials/search.html')
{% include 'oscar_pg_search/partials/search.html' %}
Optional Filter Forms
To use the included filter forms, include them in the template eg. in 'oscar/layout_2_col.html' after '{% block column_left_extra %}{% endblock %}'.
{% include 'oscar_pg_search/catalogue/partials/filter_forms.html' %}
and include the mixin into the catalogue views.
# apps/catalogue/views.py
from oscar.apps.catalogue import views
from oscar_pg_search.mixins import SearchViewMixin
class CatalogueView(SearchViewMixin, views.CatalogueView):
pass
class ProductCategoryView(SearchViewMixin, views.ProductCategoryView):
pass
Optional Use Chosen.js
To empower multiple choice fields with chosen load it eg. in 'oscar/base.html'.
# At the beginning:
{% load oscar_pg_search %}
# After jQuery is loaded:
{% oscar_pg_search_base %}
Settings
If you want to add some fields that are directly attached to the Product model:
# settings.py
OSCAR_ATTACHED_PRODUCT_FIELDS = ['is_public', 'deposit', 'volume', 'weight',]
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.
Source Distribution
Built Distribution
Hashes for django-oscar-pg-search-0.9.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a74ce394c2b7402cc8b6624231b7050ec966c348f238614c8664f2f737889aa |
|
MD5 | b13ae6cf0503bad044fa7bf24d486e37 |
|
BLAKE2b-256 | d3605a1cb2845488bf3e056f0821729f373e38b70cf8763a9c0f444efc056c9e |
Hashes for django_oscar_pg_search-0.9.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8873135812b47e1147710f048501a2aa6d8900e77eefd546d1fb931899101277 |
|
MD5 | 7f92491b4eae2262bed91fb873305fb7 |
|
BLAKE2b-256 | 2add5d1237ee17683823c5a8a6d803b9495540cb765f24ea7afbbbf7fb859425 |