sqlalchemy.ext.associationproxy.ColumnAssociationProxyInstance

class documentation

class ColumnAssociationProxyInstance(ColumnOperators, AssociationProxyInstance):

an .AssociationProxyInstance that has a database column as a target.

Method	`operate`	Operate on an argument.
Method	`__eq__`	Implement the `==` operator.
Class Variable	`_is_canonical`	Undocumented
Class Variable	`_target_is_object`	Undocumented

Inherited from ColumnOperators:

Method	`__add__`	Implement the `+` operator.
Method	`__contains__`	Undocumented
Method	`__div__`	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	`__ne__`	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	`contains`	Implement the 'contains' 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	`__slots__`	Undocumented
Class Variable	`timetuple`	Hack, allows datetime objects to be compared on the LHS.

Inherited from Operators (via 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.
Method	`reverse_operate`	Reverse operate on an argument.

Inherited from AssociationProxyInstance:

Class Method	`for_proxy`	Undocumented
Method	`any`	Produce a proxied 'any' expression using EXISTS.
Method	`delete`	Undocumented
Method	`get`	Undocumented
Method	`has`	Produce a proxied 'has' expression using EXISTS.
Method	`set`	Undocumented
Instance Variable	`target_class`	The intermediary class handled by this `.AssociationProxyInstance`.
Class Method	`_cls_unwrap_target_assoc_proxy`	Undocumented
Class Method	`_construct_for_assoc`	Undocumented
Method	`__clause_element__`	Undocumented
Method	`__init__`	Undocumented
Method	`__repr__`	Undocumented
Method	`_criterion_exists`	Undocumented
Method	`_default_getset`	Undocumented
Method	`_get_property`	Undocumented
Method	`_inflate`	Undocumented
Method	`_initialize_scalar_accessors`	Undocumented
Method	`_new`	Undocumented
Method	`_set`	Undocumented
Instance Variable	`_scalar_get`	Undocumented
Instance Variable	`_scalar_set`	Undocumented
Instance Variable	`collection_class`	Undocumented
Instance Variable	`key`	Undocumented
Instance Variable	`owning_class`	Undocumented
Instance Variable	`parent`	Undocumented
Instance Variable	`target_collection`	Undocumented
Instance Variable	`value_attr`	Undocumented
Property	`_comparator`	Undocumented
Property	`_unwrap_target_assoc_proxy`	Undocumented
Property	`_value_is_scalar`	Undocumented
Property	`attr`	Return a tuple of `(local_attr, remote_attr)`.
Property	`info`	Undocumented
Property	`local_attr`	The 'local' class attribute referenced by this `.AssociationProxyInstance`.
Property	`remote_attr`	The 'remote' class attribute referenced by this `.AssociationProxyInstance`.
Property	`scalar`	Return `True` if this `.AssociationProxyInstance` proxies a scalar relationship on the local side.

def operate(self, op, *other, **kwargs):

overrides sqlalchemy.sql.operators.Operators.operate

Operate on an argument.

This is the lowest level of operation, raises NotImplementedError by default.

Overriding this on a subclass can allow common behavior to be applied to all operations. For example, overriding .ColumnOperators to apply func.lower() to the left and right side:

class MyComparator(ColumnOperators):
    def operate(self, op, other):
        return op(func.lower(self), func.lower(other))

Parameters
op	Operator callable.
*other	the 'other' side of the operation. Will be a single scalar for most operations.
**kwargs	modifiers. These may be passed by special operators such as `ColumnOperators.contains`.

def __eq__(self, other):

overrides sqlalchemy.sql.operators.ColumnOperators.__eq__

Implement the == operator.

In a column context, produces the clause a = b. If the target is None, produces a IS NULL.

_is_canonical: bool =

Undocumented

_target_is_object: bool =

overrides sqlalchemy.ext.associationproxy.AssociationProxyInstance._target_is_object

Undocumented