sqlalchemy.engine.result.FilterResult

class documentation

class FilterResult(ResultInternal[_R]): (source)

Known subclasses: sqlalchemy.engine.result.MappingResult, sqlalchemy.engine.result.ScalarResult, sqlalchemy.engine.result.TupleResult, sqlalchemy.ext.asyncio.result.AsyncCommon

View In Hierarchy

A wrapper for a :class:`_engine.Result` that returns objects other than :class:`_engine.Row` objects, such as dictionaries or scalar objects. :class:`_engine.FilterResult` is the common base for additional result APIs including :class:`_engine.MappingResult`, :class:`_engine.ScalarResult` and :class:`_engine.AsyncResult`.

Method __enter__ Undocumented
Method __exit__ Undocumented
Method close Close this :class:`_engine.FilterResult`.
Method yield_per Configure the row-fetching strategy to fetch ``num`` rows at a time.
Class Variable __slots__ Undocumented
Property closed Return ``True`` if the underlying :class:`_engine.Result` reports closed
Method _fetchall_impl Undocumented
Method _fetchiter_impl Undocumented
Method _fetchmany_impl Undocumented
Method _fetchone_impl Undocumented
Method _soft_close Undocumented
Class Variable _post_creational_filter Undocumented
Instance Variable _real_result Undocumented
Property _attributes Undocumented
Property _soft_closed Undocumented

Inherited from ResultInternal:

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 _row_logging_fn Undocumented
Class Variable _source_supports_scalars Undocumented
Class Variable _unique_filter_state Undocumented
Instance Variable _generate_rows Undocumented
Instance Variable _metadata Undocumented

Inherited from InPlaceGenerative (via ResultInternal):

Method _generate Undocumented
def __enter__(self) -> Self: (source)

Undocumented

def __exit__(self, type_: Any, value: Any, traceback: Any): (source)

Undocumented

def close(self): (source)
overridden in sqlalchemy.ext.asyncio.result.AsyncCommon

Close this :class:`_engine.FilterResult`. .. versionadded:: 1.4.43

@_generative
def yield_per(self, num: int) -> Self: (source)

Configure the row-fetching strategy to fetch ``num`` rows at a time. The :meth:`_engine.FilterResult.yield_per` method is a pass through to the :meth:`_engine.Result.yield_per` method. See that method's documentation for usage notes. .. versionadded:: 1.4.40 - added :meth:`_engine.FilterResult.yield_per` so that the method is available on all result set implementations .. seealso:: :ref:`engine_stream_results` - describes Core behavior for :meth:`_engine.Result.yield_per` :ref:`orm_queryguide_yield_per` - in the :ref:`queryguide_toplevel`

__slots__: tuple[str, ...] = (source)
overrides sqlalchemy.engine.result.ResultInternal.__slots__
overridden in sqlalchemy.engine.result.MappingResult, sqlalchemy.engine.result.ScalarResult, sqlalchemy.engine.result.TupleResult, sqlalchemy.ext.asyncio.result.AsyncCommon

Undocumented

@property
closed: bool = (source)
overridden in sqlalchemy.ext.asyncio.result.AsyncCommon

Return ``True`` if the underlying :class:`_engine.Result` reports 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[_InterimRowType[Row[Any]]]: (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

Undocumented

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

Undocumented

def _soft_close(self, hard: bool = False): (source)
overrides sqlalchemy.engine.result.ResultInternal._soft_close

Undocumented

_post_creational_filter: Optional[Callable[[Any], Any]] = (source)
overrides sqlalchemy.engine.result.ResultInternal._post_creational_filter
overridden in sqlalchemy.engine.result.MappingResult, sqlalchemy.engine.result.ScalarResult, sqlalchemy.ext.asyncio.result.AsyncMappingResult, sqlalchemy.ext.asyncio.result.AsyncResult, sqlalchemy.ext.asyncio.result.AsyncScalarResult

Undocumented

_real_result = (source)
overrides sqlalchemy.engine.result.ResultInternal._real_result
overridden in sqlalchemy.engine.result.MappingResult, sqlalchemy.engine.result.ScalarResult, sqlalchemy.ext.asyncio.result.AsyncCommon

Undocumented

@property
_attributes: Dict[Any, Any] = (source)

Undocumented

@property
_soft_closed: bool = (source)

Undocumented