sqlalchemy.dialects.postgresql.ranges.AbstractRange.comparator_factory

class documentation

class comparator_factory(sqltypes.Concatenable.Comparator[Range[Any]]): (source)

View In Hierarchy

Define comparison operations for range types.

Method __ne__ Boolean expression. Returns true if two ranges are not equal
Method adjacent_to Boolean expression. Returns true if the range in the column is adjacent to the range in the operand.
Method contained_by Boolean expression. Returns true if the column is contained within the right hand operand.
Method contains Boolean expression. Returns true if the right hand operand, which can be an element or a range, is contained within the column.
Method difference Range expression. Returns the union of the two ranges. Will raise an exception if the resulting range is not contiguous.
Method not_extend_left_of Boolean expression. Returns true if the range in the column does not extend left of the range in the operand.
Method not_extend_right_of Boolean expression. Returns true if the range in the column does not extend right of the range in the operand.
Method overlaps Boolean expression. Returns true if the column overlaps (has points in common with) the right hand operand.
Method strictly_left_of Boolean expression. Returns true if the column is strictly left of the right hand operand.
Method strictly_right_of Boolean expression. Returns true if the column is strictly right of the right hand operand.
Method union Range expression. Returns the union of the two ranges. Will raise an exception if the resulting range is not contiguous.

Inherited from Comparator:

Class Variable __slots__ Undocumented
Method _adapt_expression evaluate the return type of <self> <op> <othertype>, and apply any adaptations to the given operator.

Inherited from Comparator (via Comparator):

Method __clause_element__ Undocumented
Method __init__ Undocumented
Method __reduce__ Undocumented
Method operate Operate on an argument.
Method reverse_operate Reverse operate on an argument.
Instance Variable expr Undocumented
Instance Variable type Undocumented

Inherited from ColumnOperators (via Comparator, Comparator):

Method __add__ Implement the ``+`` operator.
Method __contains__ Undocumented
Method __eq__ Implement the ``==`` operator.
Method __floordiv__ Implement the ``//`` operator.
Method __ge__ Implement the ``>=`` operator.
Method __getitem__ Implement the [] operator.
Method __gt__ Implement the ``>`` operator.
Method __le__ Implement the ``<=`` operator.
Method __lshift__ implement the << operator.
Method __lt__ Implement the ``<`` operator.
Method __mod__ Implement the ``%`` operator.
Method __mul__ Implement the ``*`` operator.
Method __neg__ Implement the ``-`` operator.
Method __radd__ Implement the ``+`` operator in reverse.
Method __rfloordiv__ Implement the ``//`` operator in reverse.
Method __rmod__ Implement the ``%`` operator in reverse.
Method __rmul__ Implement the ``*`` operator in reverse.
Method __rshift__ implement the >> operator.
Method __rsub__ Implement the ``-`` operator in reverse.
Method __rtruediv__ Implement the ``/`` operator in reverse.
Method __sub__ Implement the ``-`` operator.
Method __truediv__ Implement the ``/`` operator.
Method all_ Produce an :func:`_expression.all_` clause against the parent object.
Method any_ Produce an :func:`_expression.any_` clause against the parent object.
Method asc Produce a :func:`_expression.asc` clause against the parent object.
Method between Produce a :func:`_expression.between` clause against the parent object, given the lower and upper range.
Method bitwise_and Produce a bitwise AND operation, typically via the ``&`` operator.
Method bitwise_lshift Produce a bitwise LSHIFT operation, typically via the ``<<`` operator.
Method bitwise_not Produce a bitwise NOT operation, typically via the ``~`` operator.
Method bitwise_or Produce a bitwise OR operation, typically via the ``|`` operator.
Method bitwise_rshift Produce a bitwise RSHIFT operation, typically via the ``>>`` operator.
Method bitwise_xor Produce a bitwise XOR operation, typically via the ``^`` operator, or ``#`` for PostgreSQL.
Method collate Produce a :func:`_expression.collate` clause against the parent object, given the collation string.
Method concat Implement the 'concat' operator.
Method desc Produce a :func:`_expression.desc` clause against the parent object.
Method distinct Produce a :func:`_expression.distinct` clause against the parent object.
Method endswith Implement the 'endswith' operator.
Method icontains Implement the ``icontains`` operator, e.g. case insensitive version of :meth:`.ColumnOperators.contains`.
Method iendswith Implement the ``iendswith`` operator, e.g. case insensitive version of :meth:`.ColumnOperators.endswith`.
Method ilike Implement the ``ilike`` operator, e.g. case insensitive LIKE.
Method in_ Implement the ``in`` operator.
Method is_ Implement the ``IS`` operator.
Method is_distinct_from Implement the ``IS DISTINCT FROM`` operator.
Method is_not Implement the ``IS NOT`` operator.
Method is_not_distinct_from Implement the ``IS NOT DISTINCT FROM`` operator.
Method isnot Undocumented
Method isnot_distinct_from Undocumented
Method istartswith Implement the ``istartswith`` operator, e.g. case insensitive version of :meth:`.ColumnOperators.startswith`.
Method like Implement the ``like`` operator.
Method match Implements a database-specific 'match' operator.
Method not_ilike implement the ``NOT ILIKE`` operator.
Method not_in implement the ``NOT IN`` operator.
Method not_like implement the ``NOT LIKE`` operator.
Method notilike Undocumented
Method notin_ Undocumented
Method notlike Undocumented
Method nulls_first Produce a :func:`_expression.nulls_first` clause against the parent object.
Method nulls_last Produce a :func:`_expression.nulls_last` clause against the parent object.
Method nullsfirst Undocumented
Method nullslast Undocumented
Method regexp_match Implements a database-specific 'regexp match' operator.
Method regexp_replace Implements a database-specific 'regexp replace' operator.
Method startswith Implement the ``startswith`` operator.
Class Variable timetuple Hack, allows datetime objects to be compared on the LHS.
Method _rconcat Implement an 'rconcat' operator.

Inherited from Operators (via Comparator, Comparator, ColumnOperators):

Method __and__ Implement the ``&`` operator.
Method __invert__ Implement the ``~`` operator.
Method __or__ Implement the ``|`` operator.
Method bool_op Return a custom boolean operator.
Method op Produce a generic operator function.
def __ne__(self, other: Any) -> ColumnElement[bool]: (source)
overrides sqlalchemy.sql.operators.ColumnOperators.__ne__

Boolean expression. Returns true if two ranges are not equal

def adjacent_to(self, other: Any) -> ColumnElement[bool]: (source)

Boolean expression. Returns true if the range in the column is adjacent to the range in the operand.

def contained_by(self, other: Any) -> ColumnElement[bool]: (source)

Boolean expression. Returns true if the column is contained within the right hand operand.

def contains(self, other: Any, **kw: Any) -> ColumnElement[bool]: (source)
overrides sqlalchemy.sql.operators.ColumnOperators.contains

Boolean expression. Returns true if the right hand operand, which can be an element or a range, is contained within the column. kwargs may be ignored by this operator but are required for API conformance.

def difference(self, other: Any) -> ColumnElement[bool]: (source)

Range expression. Returns the union of the two ranges. Will raise an exception if the resulting range is not contiguous.

def not_extend_left_of(self, other: Any) -> ColumnElement[bool]: (source)

Boolean expression. Returns true if the range in the column does not extend left of the range in the operand.

def not_extend_right_of(self, other: Any) -> ColumnElement[bool]: (source)

Boolean expression. Returns true if the range in the column does not extend right of the range in the operand.

def overlaps(self, other: Any) -> ColumnElement[bool]: (source)

Boolean expression. Returns true if the column overlaps (has points in common with) the right hand operand.

def strictly_left_of(self, other: Any) -> ColumnElement[bool]: (source)

Boolean expression. Returns true if the column is strictly left of the right hand operand.

def strictly_right_of(self, other: Any) -> ColumnElement[bool]: (source)

Boolean expression. Returns true if the column is strictly right of the right hand operand.

def union(self, other: Any) -> ColumnElement[bool]: (source)

Range expression. Returns the union of the two ranges. Will raise an exception if the resulting range is not contiguous.