sqlalchemy.ext.asyncio.result.AsyncScalarResult

class documentation

class AsyncScalarResult(AsyncCommon[_R]): (source)

View In Hierarchy

A wrapper for a :class:`_asyncio.AsyncResult` that returns scalar values rather than :class:`_row.Row` values. The :class:`_asyncio.AsyncScalarResult` object is acquired by calling the :meth:`_asyncio.AsyncResult.scalars` method. Refer to the :class:`_result.ScalarResult` object in the synchronous SQLAlchemy API for a complete behavioral description. .. versionadded:: 1.4

Method __aiter__ Undocumented
Async Method __anext__ Undocumented
Method __init__ Undocumented
Async Method all Return all scalar values in a list.
Async Method fetchall A synonym for the :meth:`_asyncio.AsyncScalarResult.all` method.
Async Method fetchmany Fetch many objects.
Async Method first Fetch the first object or ``None`` if no object is present.
Async Method one Return exactly one object or raise an exception.
Async Method one_or_none Return at most one object or raise an exception.
Async Method partitions Iterate through sub-lists of elements of the size given.
Method unique Apply unique filtering to the objects returned by this :class:`_asyncio.AsyncScalarResult`.
Class Variable __slots__ Undocumented
Class Variable _generate_rows Undocumented
Instance Variable _metadata Undocumented
Instance Variable _post_creational_filter Undocumented
Instance Variable _real_result Undocumented
Instance Variable _unique_filter_state Undocumented

Inherited from AsyncCommon:

Async Method close Close this result.
Property closed proxies the .closed attribute of the underlying result object, if any, else raises ``AttributeError``.

Inherited from FilterResult (via AsyncCommon):

Method __enter__ Undocumented
Method __exit__ Undocumented
Method yield_per Configure the row-fetching strategy to fetch ``num`` rows at a time.
Method _fetchall_impl Undocumented
Method _fetchiter_impl Undocumented
Method _fetchmany_impl Undocumented
Method _fetchone_impl Undocumented
Method _soft_close Undocumented
Property _attributes Undocumented
Property _soft_closed Undocumented

Inherited from ResultInternal (via AsyncCommon, 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

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

Method _generate Undocumented
def __aiter__(self) -> AsyncScalarResult[_R]: (source)

Undocumented

async def __anext__(self) -> _R: (source)

Undocumented

def __init__(self, real_result: Result[Any], index: _KeyIndexType): (source)

Undocumented

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

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

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

A synonym for the :meth:`_asyncio.AsyncScalarResult.all` method.

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

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

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

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

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

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

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

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

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

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

def unique(self, strategy: Optional[_UniqueFilterType] = None) -> Self: (source)

Apply unique filtering to the objects returned by this :class:`_asyncio.AsyncScalarResult`. See :meth:`_asyncio.AsyncResult.unique` for usage details.

__slots__: tuple = (source)
overrides sqlalchemy.ext.asyncio.result.AsyncCommon.__slots__

Undocumented

_generate_rows: bool = (source)
overrides sqlalchemy.engine.result.ResultInternal._generate_rows

Undocumented

_metadata = (source)
overrides sqlalchemy.ext.asyncio.result.AsyncCommon._metadata

Undocumented

_post_creational_filter = (source)
overrides sqlalchemy.engine.result.FilterResult._post_creational_filter

Undocumented

_real_result = (source)
overrides sqlalchemy.ext.asyncio.result.AsyncCommon._real_result

Undocumented

_unique_filter_state = (source)
overrides sqlalchemy.engine.result.ResultInternal._unique_filter_state

Undocumented