sqlalchemy.sql.sqltypes.JSON.Comparator

class documentation

class Comparator(Indexable.Comparator[_T], Concatenable.Comparator[_T]): (source)

Known subclasses: sqlalchemy.dialects.postgresql.json.JSON.Comparator

Define comparison operations for :class:`_types.JSON`.

Method	`as_boolean`	Cast an indexed value as boolean.
Method	`as_float`	Cast an indexed value as float.
Method	`as_integer`	Cast an indexed value as integer.
Method	`as_json`	Cast an indexed value as JSON.
Method	`as_numeric`	Cast an indexed value as numeric/decimal.
Method	`as_string`	Cast an indexed value as string.
Class Variable	`__slots__`	Undocumented
Method	`_binary_w_type`	Undocumented
Method	`_setup_getitem`	Undocumented

Inherited from Comparator:

Method __getitem__ Implement the [] operator.

Inherited from Comparator (via 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, 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, 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	`__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	`__ne__`	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	`contains`	Implement the 'contains' 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, 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 as_boolean(self): (source) ¶

Cast an indexed value as boolean. e.g.:: stmt = select( mytable.c.json_column['some_data'].as_boolean() ).where( mytable.c.json_column['some_data'].as_boolean() == True ) .. versionadded:: 1.3.11

def as_float(self): (source) ¶

Cast an indexed value as float. e.g.:: stmt = select( mytable.c.json_column['some_data'].as_float() ).where( mytable.c.json_column['some_data'].as_float() == 29.75 ) .. versionadded:: 1.3.11

def as_integer(self): (source) ¶

Cast an indexed value as integer. e.g.:: stmt = select( mytable.c.json_column['some_data'].as_integer() ).where( mytable.c.json_column['some_data'].as_integer() == 5 ) .. versionadded:: 1.3.11

def as_json(self): (source) ¶

Cast an indexed value as JSON. e.g.:: stmt = select(mytable.c.json_column['some_data'].as_json()) This is typically the default behavior of indexed elements in any case. Note that comparison of full JSON structures may not be supported by all backends. .. versionadded:: 1.3.11

def as_numeric(self, precision, scale, asdecimal=True): (source) ¶

Cast an indexed value as numeric/decimal. e.g.:: stmt = select( mytable.c.json_column['some_data'].as_numeric(10, 6) ).where( mytable.c. json_column['some_data'].as_numeric(10, 6) == 29.75 ) .. versionadded:: 1.4.0b2

def as_string(self): (source) ¶

Cast an indexed value as string. e.g.:: stmt = select( mytable.c.json_column['some_data'].as_string() ).where( mytable.c.json_column['some_data'].as_string() == 'some string' ) .. versionadded:: 1.3.11

__slots__: tuple = (source) ¶

overrides sqlalchemy.sql.sqltypes.Indexable.Comparator.__slots__

Undocumented

def _binary_w_type(self, typ, method_name): (source) ¶

Undocumented

def _setup_getitem(self, index): (source) ¶

overrides sqlalchemy.sql.sqltypes.Indexable.Comparator._setup_getitem

Undocumented