Skip to content

Commit ca408f8

Browse files
committed
Update docstrings for get_query_rows and get_query_results
1 parent 1dfbf6a commit ca408f8

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

bigquery/client.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,10 @@ def check_job(self, job_id):
292292

293293
def get_query_rows(self, job_id, offset=None, limit=None, timeout=0):
294294
"""Retrieve a list of rows from a query table by job id.
295+
This method will append results from multiple pages together. If you want
296+
to manually page through results, you can use `get_query_results`
297+
method directly.
298+
295299
Args:
296300
job_id: The job id that references a BigQuery query.
297301
offset: The offset of the rows to pull from BigQuery.
@@ -1066,7 +1070,9 @@ def _in_range(self, start_time, end_time, time):
10661070
time <= end_time <= time + ONE_MONTH
10671071

10681072
def get_query_results(self, job_id, offset=None, limit=None, page_token=None, timeout=0):
1069-
"""Execute the query job indicated by the given job id.
1073+
"""Execute the query job indicated by the given job id. This is direct mapping to
1074+
bigquery api https://cloud.google.com/bigquery/docs/reference/v2/jobs/getQueryResults
1075+
10701076
Args:
10711077
job_id: The job id of the query to check.
10721078
offset: The index the result set should start at.

0 commit comments

Comments
 (0)