sqlalchemy.sql.operators

module documentation
(source)

Defines operators used in SQL expressions.

Class ColumnOperators Defines boolean, comparison, and other operators for :class:`_expression.ColumnElement` expressions.
Class custom_op Represent a 'custom' operator.
Class Operators Base of comparison and logical operators.
Class OperatorType describe an op() function.
Function all_op Undocumented
Function any_op Undocumented
Function as_ Undocumented
Function asc_op Undocumented
Function between_op Undocumented
Function bitwise_and_op Undocumented
Function bitwise_lshift_op Undocumented
Function bitwise_not_op Undocumented
Function bitwise_or_op Undocumented
Function bitwise_rshift_op Undocumented
Function bitwise_xor_op Undocumented
Function collate Undocumented
Function comma_op Undocumented
Function commutative_op Undocumented
Function comparison_op Undocumented
Function concat_op Undocumented
Function contains_op Undocumented
Function desc_op Undocumented
Function distinct_op Undocumented
Function endswith_op Undocumented
Function exists Undocumented
Function filter_op Undocumented
Function from_ Undocumented
Function function_as_comparison_op Undocumented
Function icontains_op Undocumented
Function iendswith_op Undocumented
Function ilike_op Undocumented
Function in_op Undocumented
Function is_ Undocumented
Function is_associative Undocumented
Function is_boolean Undocumented
Function is_commutative Undocumented
Function is_comparison Undocumented
Function is_distinct_from Undocumented
Function is_false Undocumented
Function is_natural_self_precedent Undocumented
Function is_not Undocumented
Function is_not_distinct_from Undocumented
Function is_ordering_modifier Undocumented
Function is_precedent Undocumented
Function is_true Undocumented
Function isfalse Undocumented
Function isnot Undocumented
Function isnot_distinct_from Undocumented
Function istartswith_op Undocumented
Function istrue Undocumented
Function json_getitem_op Undocumented
Function json_path_getitem_op Undocumented
Function like_op Undocumented
Function match_op Undocumented
Function mirror rotate a comparison operator 180 degrees.
Function not_between_op Undocumented
Function not_contains_op Undocumented
Function not_endswith_op Undocumented
Function not_icontains_op Undocumented
Function not_iendswith_op Undocumented
Function not_ilike_op Undocumented
Function not_in_op Undocumented
Function not_istartswith_op Undocumented
Function not_like_op Undocumented
Function not_match_op Undocumented
Function not_regexp_match_op Undocumented
Function not_startswith_op Undocumented
Function notbetween_op Undocumented
Function notcontains_op Undocumented
Function notendswith_op Undocumented
Function notilike_op Undocumented
Function notin_op Undocumented
Function notlike_op Undocumented
Function notmatch_op Undocumented
Function notstartswith_op Undocumented
Function nulls_first_op Undocumented
Function nulls_last_op Undocumented
Function nullsfirst_op Undocumented
Function nullslast_op Undocumented
Function op Undocumented
Function regexp_match_op Undocumented
Function regexp_replace_op Undocumented
Function startswith_op Undocumented
Variable add Undocumented
Variable and_ Undocumented
Variable contains Undocumented
Variable eq Undocumented
Variable floordiv Undocumented
Variable ge Undocumented
Variable getitem Undocumented
Variable gt Undocumented
Variable inv Undocumented
Variable le Undocumented
Variable lshift Undocumented
Variable lt Undocumented
Variable mod Undocumented
Variable mul Undocumented
Variable ne Undocumented
Variable neg Undocumented
Variable or_ Undocumented
Variable rshift Undocumented
Variable sub Undocumented
Variable truediv Undocumented
Class _OpLimit Undocumented
Function _asbool Undocumented
Function _escaped_like_impl Undocumented
Function _operator_fn Undocumented
Constant _PRECEDENCE Undocumented
Type Variable _FN Undocumented
Type Variable _T Undocumented
Variable _associative Undocumented
Variable _booleans Undocumented
Variable _commutative Undocumented
Variable _comparison Undocumented
Variable _mirror Undocumented
Variable _natural_self_precedent Operators where if we have (a op b) op c, we don't want to parenthesize (a op b).
@_operator_fn
def all_op(a: Any) -> Any: (source)

Undocumented

@_operator_fn
def any_op(a: Any) -> Any: (source)

Undocumented

@_operator_fn
def as_() -> Any: (source)

Undocumented

@_operator_fn
def asc_op(a: Any) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def between_op(a: Any, b: Any, c: Any, symmetric: bool = False) -> Any: (source)

Undocumented

@_operator_fn
def bitwise_and_op(a: Any, b: Any) -> Any: (source)

Undocumented

@_operator_fn
def bitwise_lshift_op(a: Any, b: Any) -> Any: (source)

Undocumented

@_operator_fn
def bitwise_not_op(a: Any) -> Any: (source)

Undocumented

@_operator_fn
def bitwise_or_op(a: Any, b: Any) -> Any: (source)

Undocumented

@_operator_fn
def bitwise_rshift_op(a: Any, b: Any) -> Any: (source)

Undocumented

@_operator_fn
def bitwise_xor_op(a: Any, b: Any) -> Any: (source)

Undocumented

@_operator_fn
def collate(a: Any, b: Any) -> Any: (source)

Undocumented

@_operator_fn
def comma_op(a: Any, b: Any) -> Any: (source)

Undocumented

def commutative_op(fn: _FN) -> _FN: (source)

Undocumented

def comparison_op(fn: _FN) -> _FN: (source)

Undocumented

@_operator_fn
def concat_op(a: Any, b: Any) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def contains_op(a: Any, b: Any, escape: Optional[str] = None, autoescape: bool = False) -> Any: (source)

Undocumented

@_operator_fn
def desc_op(a: Any) -> Any: (source)

Undocumented

@_operator_fn
def distinct_op(a: Any) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def endswith_op(a: Any, b: Any, escape: Optional[str] = None, autoescape: bool = False) -> Any: (source)

Undocumented

@_operator_fn
def exists() -> Any: (source)

Undocumented

@_operator_fn
def filter_op(a: Any, b: Any) -> Any: (source)

Undocumented

@_operator_fn
def from_() -> Any: (source)

Undocumented

@_operator_fn
@comparison_op
def function_as_comparison_op() -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def icontains_op(a: Any, b: Any, escape: Optional[str] = None, autoescape: bool = False) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def iendswith_op(a: Any, b: Any, escape: Optional[str] = None, autoescape: bool = False) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def ilike_op(a: Any, b: Any, escape: Optional[str] = None) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def in_op(a: Any, b: Any) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def is_(a: Any, b: Any) -> Any: (source)

Undocumented

def is_associative(op: OperatorType) -> bool: (source)

Undocumented

def is_boolean(op: OperatorType) -> bool: (source)

Undocumented

def is_commutative(op: OperatorType) -> bool: (source)

Undocumented

def is_comparison(op: OperatorType) -> bool: (source)

Undocumented

@comparison_op
@_operator_fn
def is_distinct_from(a: Any, b: Any) -> Any: (source)

Undocumented

@_operator_fn
def is_false(a: Any) -> Any: (source)

Undocumented

def is_natural_self_precedent(op: OperatorType) -> bool: (source)

Undocumented

@comparison_op
@_operator_fn
def is_not(a: Any, b: Any) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def is_not_distinct_from(a: Any, b: Any) -> Any: (source)

Undocumented

def is_ordering_modifier(op: OperatorType) -> bool: (source)

Undocumented

def is_precedent(operator: OperatorType, against: OperatorType) -> bool: (source)

Undocumented

@_operator_fn
def is_true(a: Any) -> Any: (source)

Undocumented

@_operator_fn
def isfalse(a: Any) -> Any: (source)

Undocumented

@_operator_fn
def isnot(a: Any, b: Any) -> Any: (source)

Undocumented

@_operator_fn
def isnot_distinct_from(a: Any, b: Any) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def istartswith_op(a: Any, b: Any, escape: Optional[str] = None, autoescape: bool = False) -> Any: (source)

Undocumented

@_operator_fn
def istrue(a: Any) -> Any: (source)

Undocumented

@_operator_fn
def json_getitem_op(a: Any, b: Any) -> Any: (source)

Undocumented

@_operator_fn
def json_path_getitem_op(a: Any, b: Any) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def like_op(a: Any, b: Any, escape: Optional[str] = None) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def match_op(a: Any, b: Any, **kw: Any) -> Any: (source)

Undocumented

def mirror(op: OperatorType) -> OperatorType: (source)

rotate a comparison operator 180 degrees. Note this is not the same as negation.

@comparison_op
@_operator_fn
def not_between_op(a: Any, b: Any, c: Any, symmetric: bool = False) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def not_contains_op(a: Any, b: Any, escape: Optional[str] = None, autoescape: bool = False) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def not_endswith_op(a: Any, b: Any, escape: Optional[str] = None, autoescape: bool = False) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def not_icontains_op(a: Any, b: Any, escape: Optional[str] = None, autoescape: bool = False) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def not_iendswith_op(a: Any, b: Any, escape: Optional[str] = None, autoescape: bool = False) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def not_ilike_op(a: Any, b: Any, escape: Optional[str] = None) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def not_in_op(a: Any, b: Any) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def not_istartswith_op(a: Any, b: Any, escape: Optional[str] = None, autoescape: bool = False) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def not_like_op(a: Any, b: Any, escape: Optional[str] = None) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def not_match_op(a: Any, b: Any, **kw: Any) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def not_regexp_match_op(a: Any, b: Any, flags: Optional[str] = None) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def not_startswith_op(a: Any, b: Any, escape: Optional[str] = None, autoescape: bool = False) -> Any: (source)

Undocumented

@_operator_fn
def notbetween_op(a: Any, b: Any, c: Any, symmetric: bool = False) -> Any: (source)

Undocumented

@_operator_fn
def notcontains_op(a: Any, b: Any, escape: Optional[str] = None, autoescape: bool = False) -> Any: (source)

Undocumented

@_operator_fn
def notendswith_op(a: Any, b: Any, escape: Optional[str] = None, autoescape: bool = False) -> Any: (source)

Undocumented

@_operator_fn
def notilike_op(a: Any, b: Any, escape: Optional[str] = None) -> Any: (source)

Undocumented

@_operator_fn
def notin_op(a: Any, b: Any) -> Any: (source)

Undocumented

@_operator_fn
def notlike_op(a: Any, b: Any, escape: Optional[str] = None) -> Any: (source)

Undocumented

@_operator_fn
def notmatch_op(a: Any, b: Any, **kw: Any) -> Any: (source)

Undocumented

@_operator_fn
def notstartswith_op(a: Any, b: Any, escape: Optional[str] = None, autoescape: bool = False) -> Any: (source)

Undocumented

@_operator_fn
def nulls_first_op(a: Any) -> Any: (source)

Undocumented

@_operator_fn
def nulls_last_op(a: Any) -> Any: (source)

Undocumented

@_operator_fn
def nullsfirst_op(a: Any) -> Any: (source)

Undocumented

@_operator_fn
def nullslast_op(a: Any) -> Any: (source)

Undocumented

@_operator_fn
def op(a: Any, opstring: str, b: Any) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def regexp_match_op(a: Any, b: Any, flags: Optional[str] = None) -> Any: (source)

Undocumented

@_operator_fn
def regexp_replace_op(a: Any, b: Any, replacement: Any, flags: Optional[str] = None) -> Any: (source)

Undocumented

@comparison_op
@_operator_fn
def startswith_op(a: Any, b: Any, escape: Optional[str] = None, autoescape: bool = False) -> Any: (source)

Undocumented

add = (source)

Undocumented

and_ = (source)

Undocumented

contains = (source)

Undocumented

eq = (source)

Undocumented

floordiv = (source)

Undocumented

ge = (source)

Undocumented

getitem = (source)

Undocumented

gt = (source)

Undocumented

inv = (source)

Undocumented

le = (source)

Undocumented

lshift = (source)

Undocumented

lt = (source)

Undocumented

mod = (source)

Undocumented

mul = (source)

Undocumented

ne = (source)

Undocumented

neg = (source)

Undocumented

or_ = (source)

Undocumented

rshift = (source)

Undocumented

sub = (source)

Undocumented

truediv = (source)

Undocumented

@_operator_fn
def _asbool(a: Any) -> Any: (source)

Undocumented

def _escaped_like_impl(fn: Callable[..., Any], other: Any, escape: Optional[str], autoescape: bool) -> Any: (source)

Undocumented

def _operator_fn(fn: Callable[..., Any]) -> OperatorType: (source)

Undocumented

_PRECEDENCE: Dict[OperatorType, int] = (source)

Undocumented

Value
{from_: 15,
 function_as_comparison_op: 15,
 any_op: 15,
 all_op: 15,
 getitem: 15,
 json_getitem_op: 15,
 json_path_getitem_op: 15,
...
_FN = (source)

Undocumented

Value
TypeVar('_FN',
        bound=Callable[..., Any])
_T = (source)

Undocumented

Value
TypeVar('_T',
        bound=Any)
_associative = (source)

Undocumented

_booleans = (source)

Undocumented

_commutative: Set[Any] = (source)

Undocumented

_comparison: Set[Any] = (source)

Undocumented

_mirror = (source)

Undocumented

_natural_self_precedent = (source)

Operators where if we have (a op b) op c, we don't want to parenthesize (a op b).