Skip to content

Filters¤

Search Filters¤

DateRangeQuery ¤

Bases: DateRangeQuery

Source code in src/couchbase_haystack/document_stores/search_filters.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class DateRangeQuery(search.DateRangeQuery):
    @property
    def inclusive_start(self) -> Optional[bool]:
        return self._json_.get("inclusive_start", None)

    @inclusive_start.setter
    def inclusive_start(
        self, value  # type: bool
    ) -> None:
        self.set_prop("inclusive_start", value)

    @property
    def inclusive_end(self) -> Optional[bool]:
        return self._json_.get("inclusive_end", None)

    @inclusive_end.setter
    def inclusive_end(
        self, value  # type: bool
    ) -> None:
        self.set_prop("inclusive_end", value)

NumericRangeQuery ¤

Bases: NumericRangeQuery

Source code in src/couchbase_haystack/document_stores/search_filters.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
class NumericRangeQuery(search.NumericRangeQuery):
    @property
    def inclusive_min(self) -> Optional[bool]:
        return self._json_.get("inclusive_min", None)

    @inclusive_min.setter
    def inclusive_min(
        self, value  # type: bool
    ) -> None:
        self.set_prop("inclusive_min", value)

    @property
    def inclusive_max(self) -> Optional[bool]:
        return self._json_.get("inclusive_max", None)

    @inclusive_max.setter
    def inclusive_max(
        self, value  # type: bool
    ) -> None:
        self.set_prop("inclusive_max", value)

_normalize_filters ¤

_normalize_filters(filters: Dict[str, Any]) -> SearchQuery

Converts Haystack filters in Couchbase compatible filters.

Parameters:

  • filters (Dict[str, Any]) –

    Dictionary containing filter conditions.

Returns:

  • SearchQuery –

    SearchQuery object for Couchbase.

Raises:

  • FilterError –

    If filters are not properly formatted.

Source code in src/couchbase_haystack/document_stores/search_filters.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
def _normalize_filters(filters: Dict[str, Any]) -> SearchQuery:
    """Converts Haystack filters in Couchbase compatible filters.

    Args:
        filters: Dictionary containing filter conditions.

    Returns:
        SearchQuery object for Couchbase.

    Raises:
        FilterError: If filters are not properly formatted.
    """
    if not isinstance(filters, dict):
        msg = "Filters must be a dictionary"
        raise FilterError(msg)

    if "field" in filters:
        return _parse_comparison_condition(filters)
    return _parse_logical_condition(filters)

SQL Filters¤

normalize_sql_filters ¤

normalize_sql_filters(filters: Dict[str, Any]) -> str

Converts Haystack filters to a SQL++ (N1QL) compatible WHERE clause.

:param filters: The Haystack filters dictionary :returns: SQL++ compatible WHERE clause string :raises FilterError: If the filters are invalid

Source code in src/couchbase_haystack/document_stores/sql_filters.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
def normalize_sql_filters(filters: Dict[str, Any]) -> str:
    """
    Converts Haystack filters to a SQL++ (N1QL) compatible WHERE clause.

    :param filters: The Haystack filters dictionary
    :returns: SQL++ compatible WHERE clause string
    :raises FilterError: If the filters are invalid
    """
    if not isinstance(filters, dict):
        msg = "Filters must be a dictionary"
        raise FilterError(msg)

    if "field" in filters:
        return _parse_comparison_condition(filters)
    return _parse_logical_condition(filters)