sqlalchemy.engine.result.TupleResult

class documentation

class TupleResult(FilterResult[_R], util.TypingOnly): (source)

View In Hierarchy

A :class:`_engine.Result` that's typed as returning plain Python tuples instead of rows. Since :class:`_engine.Row` acts like a tuple in every way already, this class is a typing only class, regular :class:`_engine.Result` is still used at runtime.

Method __iter__ Undocumented
Method __next__ Undocumented
Method all Return all scalar values in a list.
Method fetchall A synonym for the :meth:`_engine.ScalarResult.all` method.
Method fetchmany Fetch many objects.
Method fetchone Fetch one tuple.
Method first Fetch the first object or ``None`` if no object is present.
Method one Return exactly one object or raise an exception.
Method one_or_none Return at most one object or raise an exception.
Method partitions Iterate through sub-lists of elements 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 or no scalar result.
Class Variable __slots__ Undocumented

Inherited from FilterResult:

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.
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 (via FilterResult):

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 FilterResult, ResultInternal):

Method _generate Undocumented

Inherited from TypingOnly (via FilterResult, ResultInternal, InPlaceGenerative):

Method __init_subclass__ Undocumented
def __iter__(self) -> Iterator[_R]: (source)

Undocumented

def __next__(self) -> _R: (source)

Undocumented

def all(self) -> Sequence[_R]: (source)

Return all scalar values in a list. Equivalent to :meth:`_engine.Result.all` except that tuple values, rather than :class:`_engine.Row` objects, are returned.

def fetchall(self) -> Sequence[_R]: (source)

A synonym for the :meth:`_engine.ScalarResult.all` method.

def fetchmany(self, size: Optional[int] = None) -> Sequence[_R]: (source)

Fetch many objects. Equivalent to :meth:`_engine.Result.fetchmany` except that tuple values, rather than :class:`_engine.Row` objects, are returned.

def fetchone(self) -> Optional[_R]: (source)

Fetch one tuple. Equivalent to :meth:`_engine.Result.fetchone` except that tuple values, rather than :class:`_engine.Row` objects, are returned.

def first(self) -> Optional[_R]: (source)

Fetch the first object or ``None`` if no object is present. Equivalent to :meth:`_engine.Result.first` except that tuple values, rather than :class:`_engine.Row` objects, are returned.

def one(self) -> _R: (source)

Return exactly one object or raise an exception. Equivalent to :meth:`_engine.Result.one` except that tuple values, rather than :class:`_engine.Row` objects, are returned.

def one_or_none(self) -> Optional[_R]: (source)

Return at most one object or raise an exception. Equivalent to :meth:`_engine.Result.one_or_none` except that tuple values, rather than :class:`_engine.Row` objects, are returned.

def partitions(self, size: Optional[int] = None) -> Iterator[Sequence[_R]]: (source)

Iterate through sub-lists of elements of the size given. Equivalent to :meth:`_engine.Result.partitions` except that tuple values, rather than :class:`_engine.Row` objects, are returned.

@overload
def scalar(self: TupleResult[Tuple[_T]]) -> Optional[_T]:
@overload
def scalar(self) -> Any:
(source)

Fetch the first column of the first row, and close the result set. Returns ``None`` if there are no rows to fetch. No validation is performed to test if additional rows remain. After calling this method, the object is fully closed, e.g. the :meth:`_engine.CursorResult.close` method will have been called. :return: a Python scalar value , or ``None`` if no rows remain.

@overload
def scalar_one(self: TupleResult[Tuple[_T]]) -> _T:
@overload
def scalar_one(self) -> Any:
(source)

Return exactly one scalar result or raise an exception. This is equivalent to calling :meth:`_engine.Result.scalars` and then :meth:`_engine.Result.one`. .. seealso:: :meth:`_engine.Result.one` :meth:`_engine.Result.scalars`

@overload
def scalar_one_or_none(self: TupleResult[Tuple[_T]]) -> Optional[_T]:
@overload
def scalar_one_or_none(self) -> Optional[Any]:
(source)

Return exactly one or no scalar result. This is equivalent to calling :meth:`_engine.Result.scalars` and then :meth:`_engine.Result.one_or_none`. .. seealso:: :meth:`_engine.Result.one_or_none` :meth:`_engine.Result.scalars`

__slots__: tuple = (source)
overrides sqlalchemy.engine.result.FilterResult.__slots__

Undocumented