class documentation

class AsyncScalarResult(AsyncCommon):

View In Hierarchy

A wrapper for a _asyncio.AsyncResult that returns scalar values rather than _row.Row values.

The _asyncio.AsyncScalarResult object is acquired by calling the _asyncio.AsyncResult.scalars method.

Refer to the _result.ScalarResult object in the synchronous SQLAlchemy API for a complete behavioral description.

New in version 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 _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 _asyncio.AsyncScalarResult.
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.

Inherited from FilterResult (via AsyncCommon):

Method ​_fetchall​_impl Undocumented
Method ​_fetchiter​_impl Undocumented
Method ​_fetchmany​_impl Undocumented
Method ​_fetchone​_impl Undocumented
Method ​_soft​_close Undocumented
Property ​_attributes 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

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

Method ​_generate Undocumented
def __aiter__(self):

Undocumented

async def __anext__(self):

Undocumented

def __init__(self, real_result, index):

Undocumented

async def all(self):

Return all scalar values in a list.

Equivalent to _asyncio.AsyncResult.all except that scalar values, rather than _result.Row objects, are returned.

async def fetchall(self):
A synonym for the _asyncio.AsyncScalarResult.all method.
async def fetchmany(self, size=None):

Fetch many objects.

Equivalent to _asyncio.AsyncResult.fetchmany except that scalar values, rather than _result.Row objects, are returned.

async def first(self):

Fetch the first object or None if no object is present.

Equivalent to _asyncio.AsyncResult.first except that scalar values, rather than _result.Row objects, are returned.

async def one(self):

Return exactly one object or raise an exception.

Equivalent to _asyncio.AsyncResult.one except that scalar values, rather than _result.Row objects, are returned.

async def one_or_none(self):

Return at most one object or raise an exception.

Equivalent to _asyncio.AsyncResult.one_or_none except that scalar values, rather than _result.Row objects, are returned.

async def partitions(self, size=None):

Iterate through sub-lists of elements of the size given.

Equivalent to _asyncio.AsyncResult.partitions except that scalar values, rather than _result.Row objects, are returned.

def unique(self, strategy=None):

Apply unique filtering to the objects returned by this _asyncio.AsyncScalarResult.

See _asyncio.AsyncResult.unique for usage details.

_generate_rows: bool =
_metadata =

Undocumented

_post_creational_filter =
_real_result =
_unique_filter_state =