class documentation

class comparator_factory(sqltypes.Concatenable.Comparator):

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 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 __add__ Range expression. Returns the union of the two ranges. Will raise an exception if the resulting range is not contiguous.

Inherited from Comparator:

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 operate Operate on an argument.
Method reverse​_operate Reverse operate on an argument.
Method __clause​_element__ Undocumented
Method __init__ Undocumented
Method __reduce__ Undocumented
Class Variable __slots__ Undocumented
Class Variable default​_comparator Undocumented
Instance Variable expr Undocumented
Instance Variable type Undocumented

Inherited from ColumnOperators (via Comparator, Comparator):

Method __contains__ Undocumented
Method __div__ Implement the / operator.
Method __eq__ 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 __rdiv__ 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 _expression.all_ clause against the parent object.
Method any​_ Produce an _expression.any_ clause against the parent object.
Method asc Produce a _expression.asc clause against the parent object.
Method between Produce a _expression.between clause against the parent object, given the lower and upper range.
Method collate Produce a _expression.collate clause against the parent object, given the collation string.
Method concat Implement the 'concat' operator.
Method desc Produce a _expression.desc clause against the parent object.
Method distinct Produce a _expression.distinct clause against the parent object.
Method endswith Implement the 'endswith' operator.
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 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 nulls​_first Produce a _expression.nulls_first clause against the parent object.
Method nulls​_last Produce a _expression.nulls_last clause against the parent object.
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.

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):
Boolean expression. Returns true if two ranges are not equal
def adjacent_to(self, other):
Boolean expression. Returns true if the range in the column is adjacent to the range in the operand.
def contained_by(self, other):
Boolean expression. Returns true if the column is contained within the right hand operand.
def contains(self, other, **kw):

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 not_extend_left_of(self, other):
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):
Boolean expression. Returns true if the range in the column does not extend right of the range in the operand.
def overlaps(self, other):
Boolean expression. Returns true if the column overlaps (has points in common with) the right hand operand.
def strictly_left_of(self, other):
Boolean expression. Returns true if the column is strictly left of the right hand operand.
def strictly_right_of(self, other):
Boolean expression. Returns true if the column is strictly right of the right hand operand.
def __add__(self, other):
Range expression. Returns the union of the two ranges. Will raise an exception if the resulting range is not contiguous.