sqlalchemy.dialects.postgresql.json.JSONB.Comparator

class documentation

class Comparator(JSON.Comparator): (source)

View In Hierarchy

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

Method contained_by Boolean expression. Test if keys are a proper subset of the keys of the argument jsonb expression.
Method contains Boolean expression. Test if keys (or array) are a superset of/contained the keys of the argument jsonb expression.
Method delete_path JSONB expression. Deletes field or array element specified in the argument array.
Method has_all Boolean expression. Test for presence of all keys in jsonb
Method has_any Boolean expression. Test for presence of any key in jsonb
Method has_key Boolean expression. Test for presence of a key. Note that the key may be a SQLA expression.
Method path_exists Boolean expression. Test for presence of item given by the argument JSONPath expression.
Method path_match Boolean expression. Test if JSONPath predicate given by the argument JSONPath expression matches.

Inherited from Comparator:

Property astext On an indexed expression, use the "astext" (e.g. "->>") conversion when rendered in SQL.

Inherited from Comparator (via Comparator):

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 (via Comparator, Comparator):

Method __getitem__ Implement the [] operator.

Inherited from Comparator (via Comparator, Comparator, 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, 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, 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 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, 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 contained_by(self, other): (source)

Boolean expression. Test if keys are a proper subset of the keys of the argument jsonb expression.

def contains(self, other, **kwargs): (source)
overrides sqlalchemy.sql.operators.ColumnOperators.contains

Boolean expression. Test if keys (or array) are a superset of/contained the keys of the argument jsonb expression. kwargs may be ignored by this operator but are required for API conformance.

def delete_path(self, array): (source)

JSONB expression. Deletes field or array element specified in the argument array. The input may be a list of strings that will be coerced to an ``ARRAY`` or an instance of :meth:`_postgres.array`. .. versionadded:: 2.0

def has_all(self, other): (source)

Boolean expression. Test for presence of all keys in jsonb

def has_any(self, other): (source)

Boolean expression. Test for presence of any key in jsonb

def has_key(self, other): (source)

Boolean expression. Test for presence of a key. Note that the key may be a SQLA expression.

def path_exists(self, other): (source)

Boolean expression. Test for presence of item given by the argument JSONPath expression. .. versionadded:: 2.0

def path_match(self, other): (source)

Boolean expression. Test if JSONPath predicate given by the argument JSONPath expression matches. Only the first item of the result is taken into account. .. versionadded:: 2.0