-
Notifications
You must be signed in to change notification settings - Fork 1.7k
timeout_ms docs are misleading #3317
Copy link
Copy link
Closed
Labels
api: bigqueryIssues related to the BigQuery API.Issues related to the BigQuery API.priority: p2Moderately-important priority. Fix may not be included in next release.Moderately-important priority. Fix may not be included in next release.type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Metadata
Metadata
Assignees
Labels
api: bigqueryIssues related to the BigQuery API.Issues related to the BigQuery API.priority: p2Moderately-important priority. Fix may not be included in next release.Moderately-important priority. Fix may not be included in next release.type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
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.