sqlalchemy.orm.dynamic.AppenderMixin

class documentation

class AppenderMixin(AbstractCollectionWriter[_T]): (source)

Known subclasses: sqlalchemy.orm.dynamic.AppenderQuery

View In Hierarchy

A mixin that expects to be mixing in a Query class with AbstractAppender.

Method __getitem__ Undocumented
Method __init__ Undocumented
Method __iter__ Undocumented
Method add Add an item to this :class:`_orm.AppenderQuery`.
Method add_all Add an iterable of items to this :class:`_orm.AppenderQuery`.
Method append Append an item to this :class:`_orm.AppenderQuery`.
Method count Undocumented
Method extend Add an iterable of items to this :class:`_orm.AppenderQuery`.
Method remove Remove an item from this :class:`_orm.AppenderQuery`.
Method session.setter Undocumented
Class Variable query_class Undocumented
Instance Variable sess Undocumented
Property session Undocumented
Method _generate Undocumented
Method _iter Undocumented

Inherited from AbstractCollectionWriter:

Class Variable __slots__ Undocumented
Instance Variable attr Undocumented
Instance Variable instance Undocumented
Method _add_all_impl Undocumented
Method _remove_impl Undocumented
Instance Variable _from_obj Undocumented
Instance Variable _order_by_clauses Undocumented
Instance Variable _where_criteria Undocumented
def __getitem__(self, index: Any) -> _T: (source)

Undocumented

def __init__(self, attr, state): (source)
overrides sqlalchemy.orm.writeonly.AbstractCollectionWriter.__init__

Undocumented

def __iter__(self) -> Iterator[_T]: (source)

Undocumented

def add(self, item: _T): (source)

Add an item to this :class:`_orm.AppenderQuery`. The given item will be persisted to the database in terms of the parent instance's collection on the next flush. This method is provided to assist in delivering forwards-compatibility with the :class:`_orm.WriteOnlyCollection` collection class. .. versionadded:: 2.0

def add_all(self, iterator: Iterable[_T]): (source)

Add an iterable of items to this :class:`_orm.AppenderQuery`. The given items will be persisted to the database in terms of the parent instance's collection on the next flush. This method is provided to assist in delivering forwards-compatibility with the :class:`_orm.WriteOnlyCollection` collection class. .. versionadded:: 2.0

def append(self, item: _T): (source)

Append an item to this :class:`_orm.AppenderQuery`. The given item will be persisted to the database in terms of the parent instance's collection on the next flush.

def count(self) -> int: (source)

Undocumented

def extend(self, iterator: Iterable[_T]): (source)

Add an iterable of items to this :class:`_orm.AppenderQuery`. The given items will be persisted to the database in terms of the parent instance's collection on the next flush.

def remove(self, item: _T): (source)

Remove an item from this :class:`_orm.AppenderQuery`. The given item will be removed from the parent instance's collection on the next flush.

@session.setter
def session(self, session: Session): (source)

Undocumented

query_class = (source)

Undocumented

sess = (source)

Undocumented

@property
session: Session = (source)

Undocumented

def _generate(self, sess=None): (source)

Undocumented

def _iter(self): (source)

Undocumented