Skip to content

Commit f621d17

Browse files
authored
Update 'QueryResponse.fetch_data' docstring to match changes from #3484. (#3580)
Closes #3576.
1 parent 14ff1f5 commit f621d17

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

bigquery/google/cloud/bigquery/query.py

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -414,13 +414,12 @@ def fetch_data(self, max_results=None, page_token=None, start_index=None,
414414
:param client: the client to use. If not passed, falls back to the
415415
``client`` stored on the current dataset.
416416
417-
:rtype: tuple
418-
:returns: ``(row_data, total_rows, page_token)``, where ``row_data``
419-
is a list of tuples, one per result row, containing only
420-
the values; ``total_rows`` is a count of the total number
421-
of rows in the table; and ``page_token`` is an opaque
422-
string which can be used to fetch the next batch of rows
423-
(``None`` if no further batches can be fetched).
417+
:rtype: :class:`~google.cloud.iterator.Iterator`
418+
:returns: Iterator of row data :class:`tuple`s. During each page, the
419+
iterator will have the ``total_rows`` attribute set,
420+
which counts the total number of rows **in the result
421+
set** (this is distinct from the total number of rows in
422+
the current page: ``iterator.page.num_items``).
424423
:raises: ValueError if the query has not yet been executed.
425424
"""
426425
if self.name is None:

0 commit comments

Comments
 (0)