Skip to content

timeout_ms docs are misleading #3317

@roscoejp

Description

@roscoejp

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.

Metadata

Metadata

Labels

api: bigqueryIssues related to the BigQuery API.priority: p2Moderately-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.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions