Class ExecuteQueryIterator (2.30.1) 

ExecuteQueryIterator(
    client: DataClientType,
    instance_id: str,
    app_profile_id: Optional[str],
    request_body: Dict[str, Any],
    prepare_metadata: Metadata,
    attempt_timeout: float | None,
    operation_timeout: float,
    req_metadata: Sequence[Tuple[str, str]] = (),
    retryable_excs: Sequence[type[Exception]] = (),
)

Collects responses from ExecuteQuery requests and parses them into QueryResultRows.

Please Note this is not meant to be constructed directly by applications. It should always be created via the client. The constructor is subject to change.

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

Properties

app_profile_id

Returns the app_profile_id of the iterator.

is_closed

Returns True if the iterator is closed, False otherwise.

metadata

Returns query metadata from the server or None if the iterator has been closed or if metadata has not been set yet.

Metadata will not be set until the first row has been yielded or response with no rows completes.

raises: EarlyMetadataCallError when called before the first row has been returned or the iterator has completed with no rows in the response.

table_name

Returns the table_name of the iterator.

Methods

__next__

__next__() -> google.cloud.bigtable.data.execute_query.values.QueryResultRow

Yields QueryResultRows representing the results of the query.

Exceptions
Type Description
`ValueErro

close

close() -> None

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

Exceptions
Type Description
`ValueErro