Skip to content

Update 'QueryResponse.fetch_data' docstring to match changes from #3484. #3580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tseaver merged 1 commit into from
Jul 5, 2017
Merged

Update 'QueryResponse.fetch_data' docstring to match changes from #3484. #3580

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions bigquery/google/cloud/bigquery/query.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down