Class ExecuteQueryIteratorAsync (2.26.0)

ExecuteQueryIteratorAsync(
    client: BigtableDataClientAsync,
    instance_id: str,
    app_profile_id: Optional[str],
    request_body: Dict[str, Any],
    attempt_timeout: float | None,
    operation_timeout: float,
    req_metadata: Sequence[Tuple[str, str]],
    retryable_excs: List[type[Exception]],
)

ExecuteQueryIteratorAsync handles collecting streaming responses from the ExecuteQuery RPC and parsing them to QueryResultRows.

ExecuteQueryIteratorAsync implements Asynchronous Iterator interface and can be used with "async for" syntax. It is also a context manager.

It is not thread-safe. It should not be used by multiple asyncio Tasks.

Properties

app_profile_id

Returns the app_profile_id of the iterator.

is_closed

Returns True if the iterator is closed, False otherwise.

table_name

Returns the table_name of the iterator.

Methods

close

close() -> None

Cancel all background tasks. Should be called all rows were processed.

metadata

metadata() -> (
    typing.Optional[google.cloud.bigtable.data.execute_query.metadata.Metadata]
)

Returns query metadata from the server or None if the iterator was explicitly closed.