Skip to content

timeout_ms docs are misleading #3317

Closed
Closed
timeout_ms docs are misleading#3317
Assignees
lukesneeringer
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.

Description

@roscoejp
roscoejp
opened on Apr 19, 2017

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.

Activity

  1. lukesneeringer
    added
    api: bigqueryIssues related to the BigQuery API.
    docs
    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.
    on Apr 19, 2017

  2. lukesneeringer commented on Apr 19, 2017

    @lukesneeringer
    lukesneeringer
    on Apr 19, 2017
    Contributor

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

  3. roscoejp commented on Apr 21, 2017

    @roscoejp
    roscoejp
    on Apr 21, 2017
    ContributorAuthor

    #3320 to update the docs.

  4. lukesneeringer commented on Aug 8, 2017

    @lukesneeringer
    lukesneeringer
    on Aug 8, 2017
    Contributor

    #3320 was merged; closing this.

  5. lukesneeringer
    closed this as completedon Aug 8, 2017
  6. JustinBeckwith
    assigned
    lukesneeringer
    on Feb 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

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