Skip to content
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

Jump to bottom

timeout_ms docs are misleading #3317

Closed
roscoejp opened this issue Apr 19, 2017 · 3 comments
Closed

timeout_ms docs are misleading #3317

roscoejp opened this issue Apr 19, 2017 · 3 comments
Assignees
@lukesneeringer
Labels
api: bigquery Issues related to the BigQuery API. priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@roscoejp
Copy link
Contributor

roscoejp commented Apr 19, 2017 •
edited by dhermes
Loading

Docs reference timeout_ms as being the 'time to wait for the query to complete':
https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/bigquery/google/cloud/bigquery/query.py#L386

This is contradictory to the actual use of timeout_ms as the API docs describe it as the request timeout:
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#timeoutMs

TimeoutMS is distinctly NOT the time 'to wait for query to complete'. The docs should be more explicit since query vs request timeout are vastly different things.
@lukesneeringer lukesneeringer added api: bigquery Issues related to the BigQuery API. docs priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Apr 19, 2017
@lukesneeringer
Copy link
Contributor

Hi @roscoejp,
Thanks for reporting. I agree that this is in error.

@roscoejp roscoejp mentioned this issue Apr 21, 2017
Merged
@roscoejp
Copy link
Contributor Author

#3320 to update the docs.

@tseaver tseaver mentioned this issue Jun 26, 2017
Merged
@lukesneeringer
Copy link
Contributor

#3320 was merged; closing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lukesneeringer lukesneeringer

Labels
api: bigquery Issues related to the BigQuery API. priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lukesneeringer @roscoejp