WhereField

Class: warmhub.WhereField

WhereField(field_path: str)

A bound field path awaiting an operator. Returned by where.

Not hashable and not truthy-testable — see the module docstring.

Methods

eq

eq(value: WhereScalar)

Equality. The explicit spelling of where(f) == value.

ne

ne(value: WhereScalar)

Inequality. The explicit spelling of where(f) != value.

gt

gt(value: WhereScalar)

Strictly greater. The explicit spelling of where(f) > value.

gte

gte(value: WhereScalar)

Greater or equal. The explicit spelling of where(f) >= value.

Named for the wire operator (gte), not for Python’s __ge__, so the method name and the serialized op are the same string.

lt

lt(value: WhereScalar)

Strictly less. The explicit spelling of where(f) < value.

lte

lte(value: WhereScalar)

Less or equal. The explicit spelling of where(f) <= value.

prefix

prefix(value: str)

String prefix match. The RHS must be a string.

in_

in_(values: Iterable[WhereScalar])

Set membership. Trailing underscore because in is a keyword.

The array must be non-empty: an empty in matches nothing, and the backend rejects it rather than quietly returning zero rows, so this raises at the call site where the mistake is visible.

exists

exists()

Field presence. Serializes without an rhs key.

Properties and attributes

field_path

field_path = field_path

Documentation is not yet available.