sqlalchemy.engine.result

module documentation
(source)

Define generic result set constructs.

Class ChunkedIteratorResult An :class:`_engine.IteratorResult` that works from an iterator-producing callable.
Class FilterResult A wrapper for a :class:`_engine.Result` that returns objects other than :class:`_engine.Row` objects, such as dictionaries or scalar objects.
Class FrozenResult Represents a :class:`_engine.Result` object in a "frozen" state suitable for caching.
Class IteratorResult A :class:`_engine.Result` that gets data from a Python iterator of :class:`_engine.Row` objects or similar row-like data.
Class MappingResult A wrapper for a :class:`_engine.Result` that returns dictionary values rather than :class:`_engine.Row` values.
Class MergedResult A :class:`_engine.Result` that is merged from any number of :class:`_engine.Result` objects.
Class Result Represent a set of database results.
Class ResultInternal Undocumented
Class ResultMetaData Base for metadata about result rows.
Class RMKeyView Undocumented
Class ScalarResult A wrapper for a :class:`_engine.Result` that returns scalar values rather than :class:`_row.Row` values.
Class SimpleResultMetaData result metadata for in-memory collections.
Class TupleResult A :class:`_engine.Result` that's typed as returning plain Python tuples instead of rows.
Function null_result Undocumented
Function result_tuple Undocumented
Class _NoRow Undocumented
Class _WithKeys No class docstring; 0/2 class variable, 1/1 method documented
Type Variable _R Undocumented
Type Variable _T Undocumented
Type Variable _TP Undocumented
Type Alias _InterimRowType a catchall "anything" kind of return type that can be applied across all the result types
Type Alias _InterimSupportsScalarsRowType Undocumented
Type Alias _KeyIndexType Undocumented
Type Alias _KeyMapType Undocumented
Type Alias _KeyType Undocumented
Type Alias _ProcessorsType Undocumented
Type Alias _RawRowType represents the kind of row we get from a DBAPI cursor
Type Alias _RowData A generic form of "row" that accommodates for the different kinds of "rows" that different result objects return, including row, row mapping, and scalar values
Type Alias _TupleGetterType Undocumented
Type Alias _UniqueFilterStateType Undocumented
Type Alias _UniqueFilterType Undocumented
def null_result() -> IteratorResult[Any]: (source)

Undocumented

def result_tuple(fields: Sequence[str], extra: Optional[Any] = None) -> Callable[[Iterable[Any]], Row[Any]]: (source)

Undocumented

_R = (source)

Undocumented

Value
TypeVar('_R',
        bound=_RowData)
_T = (source)

Undocumented

Value
TypeVar('_T',
        bound=Any)
_TP = (source)

Undocumented

Value
TypeVar('_TP',
        bound=Tuple[Any, ...])
_InterimRowType = (source)

a catchall "anything" kind of return type that can be applied across all the result types

Value
Union[_R, _RawRowType]
_InterimSupportsScalarsRowType = (source)

Undocumented

Value
Union[Row, Any]
_KeyIndexType = (source)

Undocumented

Value
Union[str, 'Column[Any]', int]
_KeyMapType = (source)

Undocumented

Value
Dict[_KeyType, _KeyMapRecType]
_KeyType = (source)

Undocumented

Value
Union[str, 'Column[Any]']
_ProcessorsType = (source)

Undocumented

Value
Sequence[Optional['_ResultProcessorType[Any]']]
_RawRowType = (source)

represents the kind of row we get from a DBAPI cursor

Value
Tuple[Any, ...]
_RowData = (source)

A generic form of "row" that accommodates for the different kinds of "rows" that different result objects return, including row, row mapping, and scalar values

Value
Union[Row, RowMapping, Any]
_TupleGetterType = (source)

Undocumented

Value
Callable[[Sequence[Any]], Tuple[Any, ...]]
_UniqueFilterStateType = (source)

Undocumented

Value
Tuple[Set[Any], Optional[_UniqueFilterType]]
_UniqueFilterType = (source)

Undocumented

Value
Callable[[Any], Any]