sqlalchemy.ext.indexable.index

class documentation

class index_property(hybrid_property):

A property generator. The generated property describes an object attribute that corresponds to an _types.Indexable column.

New in version 1.1.

See Also

Inherited from hybrid_property:

Method	`comparator`	Provide a modifying decorator that defines a custom comparator producing method.
Method	`deleter`	Provide a modifying decorator that defines a deletion method.
Method	`expression`	Provide a modifying decorator that defines a SQL-expression producing method.
Method	`getter`	Provide a modifying decorator that defines a getter method.
Method	`setter`	Provide a modifying decorator that defines a setter method.
Method	`update_expression`	Provide a modifying decorator that defines an UPDATE tuple producing method.
Method	`__delete__`	Undocumented
Method	`__get__`	Undocumented
Method	`__set__`	Undocumented
Method	`_copy`	Undocumented
Method	`_get_comparator`	Undocumented
Method	`_get_expr`	Undocumented
Class Variable	`is_attribute`	True if this object is a Python :term:`descriptor`.
Instance Variable	`custom_comparator`	Undocumented
Instance Variable	`update_expr`	Undocumented
Property	`_expr_comparator`	Undocumented
Property	`overrides`	Prefix for a method that is overriding an existing attribute.

Property info Info dictionary associated with the object, allowing user-defined data to be associated with this .InspectionAttr.

Class Variable	`__slots__`	Undocumented
Class Variable	`_is_internal_proxy`	True if this object is an internal proxy object.
Class Variable	`is_aliased_class`	True if this object is an instance of `.AliasedClass`.
Class Variable	`is_bundle`	True if this object is an instance of `.Bundle`.
Class Variable	`is_clause_element`	True if this object is an instance of `_expression.ClauseElement`.
Class Variable	`is_instance`	True if this object is an instance of `.InstanceState`.
Class Variable	`is_mapper`	True if this object is an instance of `_orm.Mapper`.
Class Variable	`is_property`	True if this object is an instance of `.MapperProperty`.
Class Variable	`is_selectable`	Return True if this object is an instance of `_expression.Selectable`.

def __init__(self, attr_name, index, default=_NO_DEFAULT_ARGUMENT, datatype=None, mutable=True, onebased=True):

overrides sqlalchemy.ext.hybrid.hybrid_property.__init__

Create a new .index_property.

Parameters
attr_name	An attribute name of an `Indexable` typed column, or other attribute that returns an indexable structure.
index	The index to be used for getting and setting this value. This should be the Python-side index value for integers.
default	A value which will be returned instead of `AttributeError` when there is not a value at given index.
datatype	default datatype to use when the field is empty. By default, this is derived from the type of index used; a Python list for an integer index, or a Python dictionary for any other style of index. For a list, the list will be initialized to a list of None values that is at least `index` elements long.
mutable	if False, writes and deletes to the attribute will be disallowed.
onebased	assume the SQL representation of this value is one-based; that is, the first index in SQL is 1, not zero.

def _fget_default(self, err=None):

Undocumented

def expr(self, model):

overrides sqlalchemy.ext.hybrid.hybrid_property.expr

Undocumented

def fdel(self, instance):

overrides sqlalchemy.ext.hybrid.hybrid_property.fdel

Undocumented

def fget(self, instance):

overrides sqlalchemy.ext.hybrid.hybrid_property.fget

Undocumented

def fset(self, instance, value):

overrides sqlalchemy.ext.hybrid.hybrid_property.fset

Undocumented

_NO_DEFAULT_ARGUMENT =

Undocumented

Value

object()

attr_name =

Undocumented

datatype =

Undocumented

default =

Undocumented

index =

Undocumented

onebased =

Undocumented

sqlalchemy.ext.indexable.index_property