ormar/docs/api/query-set/field-accessor.md

queryset.field_accessor

FieldAccessor Objects

class FieldAccessor()

Helper to access ormar fields directly from Model class also for nested models attributes.

__bool__

 | __bool__() -> bool

Hack to avoid pydantic name check from parent model, returns false

Returns:

(bool): False

__getattr__

 | __getattr__(item: str) -> Any

Accessor return new accessor for each field and nested models. Thanks to that operator overload is possible to use in filter.

Arguments:

• item (str): attribute name

Returns:

(ormar.queryset.field_accessor.FieldAccessor): FieldAccessor for field or nested model

__eq__

 | __eq__(other: Any) -> FilterGroup

overloaded to work as sql column = <VALUE>

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

__ge__

 | __ge__(other: Any) -> FilterGroup

overloaded to work as sql column >= <VALUE>

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

__gt__

 | __gt__(other: Any) -> FilterGroup

overloaded to work as sql column > <VALUE>

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

__le__

 | __le__(other: Any) -> FilterGroup

overloaded to work as sql column <= <VALUE>

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

__lt__

 | __lt__(other: Any) -> FilterGroup

overloaded to work as sql column < <VALUE>

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

__mod__

 | __mod__(other: Any) -> FilterGroup

overloaded to work as sql column LIKE '%<VALUE>%'

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

__lshift__

 | __lshift__(other: Any) -> FilterGroup

overloaded to work as sql column IN (<VALUE1>, <VALUE2>,...)

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

__rshift__

 | __rshift__(other: Any) -> FilterGroup

overloaded to work as sql column IS NULL

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

in_

 | in_(other: Any) -> FilterGroup

works as sql column IN (<VALUE1>, <VALUE2>,...)

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

iexact

 | iexact(other: Any) -> FilterGroup

works as sql column = <VALUE> case-insensitive

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

contains

 | contains(other: Any) -> FilterGroup

works as sql column LIKE '%<VALUE>%'

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

icontains

 | icontains(other: Any) -> FilterGroup

works as sql column LIKE '%<VALUE>%' case-insensitive

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

startswith

 | startswith(other: Any) -> FilterGroup

works as sql column LIKE '<VALUE>%'

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

istartswith

 | istartswith(other: Any) -> FilterGroup

works as sql column LIKE '%<VALUE>' case-insensitive

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

endswith

 | endswith(other: Any) -> FilterGroup

works as sql column LIKE '%<VALUE>'

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

iendswith

 | iendswith(other: Any) -> FilterGroup

works as sql column LIKE '%<VALUE>' case-insensitive

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

isnull

 | isnull(other: Any) -> FilterGroup

works as sql column IS NULL or IS NOT NULL

Arguments:

• other (str): value to check agains operator

Returns:

(ormar.queryset.clause.FilterGroup): FilterGroup for operator

asc

 | asc() -> OrderAction

works as sql column asc

Returns:

(ormar.queryset.actions.OrderGroup): OrderGroup for operator

desc

 | desc() -> OrderAction

works as sql column desc

Returns:

(ormar.queryset.actions.OrderGroup): OrderGroup for operator