Class Iterator (2.21.0) 

Iterator(
    query,
    client,
    limit=None,
    offset=None,
    start_cursor=None,
    end_cursor=None,
    eventual=False,
    retry=None,
    timeout=None,
    read_time=None,
)

Represent the state of a given execution of a Query.

Parameters
Name Description
query Query

Query object holding permanent configuration (i.e. things that don't change on with each page in a results set).
client Client

The client used to make a request.
limit int

(Optional) Limit the number of results returned.
offset int

(Optional) Offset used to begin a query.
start_cursor bytes

(Optional) Cursor to begin paging through query results.
end_cursor bytes

(Optional) Cursor to end paging through query results.
eventual bool

(Optional) Defaults to strongly consistent (False). Setting True will use eventual consistency, but cannot be used inside a transaction or with read_time, otherwise will raise ValueError.
retry google.api_core.retry.Retry

A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.
timeout float

Time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
read_time datetime

(Optional) Runs the query with read time consistency. Cannot be used with eventual consistency or inside a transaction, otherwise will raise ValueError. This feature is in private preview.

Properties

explain_metrics

Get the metrics associated with the query execution. Metrics are only available when explain_options is set on the query. If ExplainOptions.analyze is False, only plan_summary is available. If it is True, execution_stats is also available.

Exceptions
Type Description
QueryExplainError if explain_metrics is not available on the query.
Returns
Type Description
ExplainMetrics The metrics associated with the query execution.