sqlalchemy.engine.result.IteratorResult

class documentation

class IteratorResult(Result[_TP]): (source)

Known subclasses: sqlalchemy.engine.result.ChunkedIteratorResult, sqlalchemy.engine.result.MergedResult

View In Hierarchy

A :class:`_engine.Result` that gets data from a Python iterator of :class:`_engine.Row` objects or similar row-like data. .. versionadded:: 1.4

Method __init__ Undocumented
Instance Variable iterator Undocumented
Instance Variable raw Undocumented
Property closed Return ``True`` if this :class:`_engine.IteratorResult` has been closed
Method _fetchall_impl Undocumented
Method _fetchiter_impl Undocumented
Method _fetchmany_impl Undocumented
Method _fetchone_impl Undocumented
Method _raise_hard_closed Undocumented
Method _raw_row_iterator Return a safe iterator that yields raw row data.
Method _soft_close Undocumented
Instance Variable _hard_closed Undocumented
Instance Variable _metadata Undocumented
Instance Variable _soft_closed Undocumented
Instance Variable _source_supports_scalars Undocumented

Inherited from Result:

Method __enter__ Undocumented
Method __exit__ Undocumented
Method __iter__ Undocumented
Method __next__ Undocumented
Method all Return all rows in a list.
Method close close this :class:`_engine.Result`.
Method columns Establish the columns that should be returned in each row.
Method fetchall A synonym for the :meth:`_engine.Result.all` method.
Method fetchmany Fetch many rows.
Method fetchone Fetch one row.
Method first Fetch the first row or ``None`` if no row is present.
Method freeze Return a callable object that will produce copies of this :class:`_engine.Result` when invoked.
Method mappings Apply a mappings filter to returned rows, returning an instance of :class:`_engine.MappingResult`.
Method merge Merge this :class:`_engine.Result` with other compatible result objects.
Method one Return exactly one row or raise an exception.
Method one_or_none Return at most one result or raise an exception.
Method partitions Iterate through sub-lists of rows of the size given.
Method scalar Fetch the first column of the first row, and close the result set.
Method scalar_one Return exactly one scalar result or raise an exception.
Method scalar_one_or_none Return exactly one scalar result or ``None``.
Method scalars Return a :class:`_engine.ScalarResult` filtering object which will return single elements rather than :class:`_row.Row` objects.
Method tuples Apply a "typed tuple" typing filter to returned rows.
Method unique Apply unique filtering to the objects returned by this :class:`_engine.Result`.
Method yield_per Configure the row-fetching strategy to fetch ``num`` rows at a time.
Class Variable __slots__ Undocumented
Property t Apply a "typed tuple" typing filter to returned rows.
Method _getter return a callable that will retrieve the given key from a :class:`_engine.Row`.
Method _tuple_getter return a callable that will retrieve the given keys from a :class:`_engine.Row`.
Class Variable _attributes Undocumented
Class Variable _row_logging_fn Undocumented
Instance Variable _unique_filter_state Undocumented
Instance Variable _yield_per Undocumented

Inherited from _WithKeys (via Result):

Method keys Return an iterable view which yields the string keys that would be represented by each :class:`_engine.Row`.

Inherited from ResultInternal (via Result, _WithKeys):

Method _allrows Undocumented
Method _column_slices Undocumented
Method _iter_impl Undocumented
Method _iterator_getter Undocumented
Method _manyrow_getter Undocumented
Method _next_impl Undocumented
Method _onerow_getter Undocumented
Method _only_one_row Undocumented
Method _raw_all_rows Undocumented
Method _row_getter Undocumented
Method _unique_strategy Undocumented
Class Variable _is_cursor Undocumented
Class Variable _post_creational_filter Undocumented
Class Variable _real_result Undocumented
Instance Variable _generate_rows Undocumented

Inherited from InPlaceGenerative (via Result, _WithKeys, ResultInternal):

Method _generate Undocumented
def __init__(self, cursor_metadata: ResultMetaData, iterator: Iterator[_InterimSupportsScalarsRowType], raw: Optional[Result[Any]] = None, _source_supports_scalars: bool = False): (source)
overrides sqlalchemy.engine.result.Result.__init__
overridden in sqlalchemy.engine.result.ChunkedIteratorResult, sqlalchemy.engine.result.MergedResult

Undocumented

iterator = (source)
overridden in sqlalchemy.engine.result.ChunkedIteratorResult

Undocumented

raw = (source)
overridden in sqlalchemy.engine.result.ChunkedIteratorResult

Undocumented

@property
closed: bool = (source)
overrides sqlalchemy.engine.result.Result.closed
overridden in sqlalchemy.engine.result.MergedResult

Return ``True`` if this :class:`_engine.IteratorResult` has been closed .. versionadded:: 1.4.43

def _fetchall_impl(self) -> List[_InterimRowType[Row[Any]]]: (source)
overrides sqlalchemy.engine.result.ResultInternal._fetchall_impl

Undocumented

def _fetchiter_impl(self) -> Iterator[_InterimSupportsScalarsRowType]: (source)
overrides sqlalchemy.engine.result.ResultInternal._fetchiter_impl

Undocumented

def _fetchmany_impl(self, size: Optional[int] = None) -> List[_InterimRowType[Row[Any]]]: (source)
overrides sqlalchemy.engine.result.ResultInternal._fetchmany_impl
overridden in sqlalchemy.engine.result.ChunkedIteratorResult

Undocumented

def _fetchone_impl(self, hard_close: bool = False) -> Optional[_InterimRowType[Row[Any]]]: (source)
overrides sqlalchemy.engine.result.ResultInternal._fetchone_impl

Undocumented

def _raise_hard_closed(self) -> NoReturn: (source)

Undocumented

def _raw_row_iterator(self) -> Iterator[_RowData]: (source)
overrides sqlalchemy.engine.result.Result._raw_row_iterator

Return a safe iterator that yields raw row data. This is used by the :meth:`_engine.Result.merge` method to merge multiple compatible results together.

def _soft_close(self, hard: bool = False, **kw: Any): (source)
overrides sqlalchemy.engine.result.ResultInternal._soft_close
overridden in sqlalchemy.engine.result.ChunkedIteratorResult, sqlalchemy.engine.result.MergedResult

Undocumented

_hard_closed: bool = (source)

Undocumented

_metadata = (source)
overrides sqlalchemy.engine.result.Result._metadata
overridden in sqlalchemy.engine.result.ChunkedIteratorResult

Undocumented

_soft_closed: bool = (source)
overrides sqlalchemy.engine.result.Result._soft_closed

Undocumented

_source_supports_scalars = (source)
overrides sqlalchemy.engine.result.Result._source_supports_scalars
overridden in sqlalchemy.engine.result.ChunkedIteratorResult, sqlalchemy.engine.result.MergedResult

Undocumented