From 2be127dac3bf7c1aad5aa178dc1ab39d2bf47582 Mon Sep 17 00:00:00 2001 From: Tres Seaver Date: Wed, 5 Jul 2017 14:02:42 -0400 Subject: [PATCH] Update 'QueryResponse.fetch_data' docstring to match changes from #3484. (#3580) Closes #3576. --- bigquery/google/cloud/bigquery/query.py | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/bigquery/google/cloud/bigquery/query.py b/bigquery/google/cloud/bigquery/query.py index 6db2742bbe013..d596deadfb405 100644 --- a/bigquery/google/cloud/bigquery/query.py +++ b/bigquery/google/cloud/bigquery/query.py @@ -414,13 +414,12 @@ def fetch_data(self, max_results=None, page_token=None, start_index=None, :param client: the client to use. If not passed, falls back to the ``client`` stored on the current dataset. - :rtype: tuple - :returns: ``(row_data, total_rows, page_token)``, where ``row_data`` - is a list of tuples, one per result row, containing only - the values; ``total_rows`` is a count of the total number - of rows in the table; and ``page_token`` is an opaque - string which can be used to fetch the next batch of rows - (``None`` if no further batches can be fetched). + :rtype: :class:`~google.cloud.iterator.Iterator` + :returns: Iterator of row data :class:`tuple`s. During each page, the + iterator will have the ``total_rows`` attribute set, + which counts the total number of rows **in the result + set** (this is distinct from the total number of rows in + the current page: ``iterator.page.num_items``). :raises: ValueError if the query has not yet been executed. """ if self.name is None: