Migrate from 0.1 to 1.0¶

REDIS_SEARCH_AUTO_INDEX = True

REDIS_SEARCH = {
    "URL": "redis://localhost:6379/0",
    "AUTO_INDEX": True,
}

from redis_om import Field

from redis_search_django.documents import EmbeddedJsonDocument, JsonDocument

from .models import Category, Product, Tag, Vendor


class CategoryDocument(EmbeddedJsonDocument):
    custom_field: str = Field(index=True, full_text_search=True)

    class Django:
        model = Category
        fields = ["name", "slug"]

    @classmethod
    def prepare_custom_field(cls, obj: Category) -> str:
        return "CUSTOM FIELD VALUE"


class TagDocument(EmbeddedJsonDocument):
    class Django:
        model = Tag
        fields = ["name"]


class VendorDocument(EmbeddedJsonDocument):
    class Django:
        model = Vendor
        fields = ["name"]


class ProductDocument(JsonDocument):
    vendor: VendorDocument
    category: CategoryDocument | None = None
    tags: list[TagDocument] = []

    class Django:
        model = Product
        fields = ["name", "description", "price"]
        related_models = {
            Vendor: {"related_name": "product", "many": False},
            Category: {"related_name": "product_set", "many": True},
            Tag: {"related_name": "product_set", "many": True},
        }

    @classmethod
    def get_queryset(cls):
        return super().get_queryset().filter(available=True)

from django.db import models

from redis_search_django import fields
from redis_search_django.documents import Document

from .models import Category, Product, Tag, Vendor


class CategoryDocument(Document):
    custom_field = fields.Text()

    class Django:
        model = Category
        fields = ["name", "slug"]
        embedded = True

    @classmethod
    def prepare_custom_field(cls, obj: Category) -> str:
        return "CUSTOM FIELD VALUE"


class TagDocument(Document):
    class Django:
        model = Tag
        fields = ["name"]
        embedded = True


class VendorDocument(Document):
    class Django:
        model = Vendor
        fields = ["name"]
        embedded = True


class ProductDocument(Document):
    vendor = fields.Object(VendorDocument)
    category = fields.Object(CategoryDocument, required=False)
    tags = fields.Nested(TagDocument)

    class Django:
        model = Product
        fields = ["name", "description", "price", "available"]
        select_related_fields = ["vendor", "category"]
        prefetch_related_fields = ["tags"]
        # related_models omitted → inferred from Object/Nested

    @classmethod
    def get_queryset(cls) -> models.QuerySet[Product]:
        return super().get_queryset().filter(available=True)

    @classmethod
    def should_index(cls, instance: models.Model) -> bool:
        return instance.available

result = (
    ProductDocument.find(
        ProductDocument.name % "shoes" | ProductDocument.description % "shoes"
    )
    .sort_by("-price")
    .execute()
)
qs = result.to_queryset()

from redis_search_django import Q

qs = (
    ProductDocument.objects.filter(
        Q(name__search="shoes") | Q(description__search="shoes")
    )
    .order_by("-price")
    .to_queryset()
)

for hit in ProductDocument.objects.filter(name__search="shoes")[:20]:
    hit.pk, hit.score, hit.name

from redis.commands.search import reducers

request = ProductDocument.build_aggregate_request(expr)
ProductDocument.aggregate(
    request.group_by(["@category_name"], reducers.count().alias("count"))
)

ProductDocument.objects.filter(name__search="shoes").facets("category__name")

from redis_search_django import Aggregate

ProductDocument.objects.filter(available=True).aggregate(
    Aggregate().group_by("vendor__name").count("count").avg("price", "avg_price")
)

from redis_search_django.mixins import RediSearchListViewMixin

class SearchView(RediSearchListViewMixin, ListView):
    document_class = ProductDocument

    @cached_property
    def search_query_expression(self):
        q = self.request.GET.get("query")
        if q:
            return self.document_class.name % q | self.document_class.description % q
        return None

from redis_search_django import Q
from redis_search_django.views import SearchListViewMixin

class SearchView(SearchListViewMixin, ListView):
    document_class = ProductDocument

    def get_search_queryset(self):
        qs = ProductDocument.objects.all()
        q = self.request.GET.get("query")
        if q:
            qs = qs.filter(Q(name__search=q) | Q(description__search=q))
        return qs

    def facets(self):
        return self.get_search_queryset().facets("category__name", "tags__name")