2.8 KiB
queryset.clause
QueryClause Objects
class QueryClause()
Constructs FilterActions from strings passed as arguments
prepare_filter
| prepare_filter(**kwargs: Any) -> Tuple[List[FilterAction], List[str]]
Main external access point that processes the clauses into sqlalchemy text clauses and updates select_related list with implicit related tables mentioned in select_related strings but not included in select_related.
Arguments:
kwargs (Any): key, value pair with column names and values
Returns:
(Tuple[List[sqlalchemy.sql.elements.TextClause], List[str]]): Tuple with list of where clauses and updated select_related list
_populate_filter_clauses
| _populate_filter_clauses(**kwargs: Any) -> Tuple[List[FilterAction], List[str]]
Iterates all clauses and extracts used operator and field from related models if needed. Based on the chain of related names the target table is determined and the final clause is escaped if needed and compiled.
Arguments:
kwargs (Any): key, value pair with column names and values
Returns:
(Tuple[List[sqlalchemy.sql.elements.TextClause], List[str]]): Tuple with list of where clauses and updated select_related list
_register_complex_duplicates
| _register_complex_duplicates(select_related: List[str]) -> None
Checks if duplicate aliases are presented which can happen in self relation or when two joins end with the same pair of models.
If there are duplicates, the all duplicated joins are registered as source model and whole relation key (not just last relation name).
Arguments:
select_related (List[str]): list of relation strings
Returns:
(None): None
_parse_related_prefixes
| _parse_related_prefixes(select_related: List[str]) -> List[Prefix]
Walks all relation strings and parses the target models and prefixes.
Arguments:
select_related (List[str]): list of relation strings
Returns:
(List[Prefix]): list of parsed prefixes
_switch_filter_action_prefixes
| _switch_filter_action_prefixes(filter_clauses: List[FilterAction]) -> List[FilterAction]
Substitutes aliases for filter action if the complex key (whole relation str) is present in alias_manager.
Arguments:
filter_clauses (List[FilterAction]): raw list of actions
Returns:
(List[FilterAction]): list of actions with aliases changed if needed