Skip to content

Spanner: Update docs for timeout_secs param in Database.run_in_transaction() #9364

Closed

Description

@skuruppu

The documentation for Database.run_in_transaction() states:

:param kw: optional keyword arguments to be passed to ``func``.
           If passed, "timeout_secs" will be removed and used to
           override the default timeout.

Based on the SO issue the documentation is misleading because users will assume that timeout_secs is the deadline for the request. Instead, this parameter is the retry timeout which is the deadline after which the transaction will stop being retried.

We need to update the documentation so that it's clear what this parameter is used for.

Activity

  1. added
    api: spannerIssues related to the Spanner API.
    type: docsImprovement to the documentation for an API.
    on Oct 1, 2019
  2. self-assigned this
    on Oct 4, 2019
  3. added a commit that references this issue on Oct 29, 2019
    ee62142
  4. added a commit that references this issue on Mar 9, 2026
    d9f2541
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

api: spannerIssues related to the Spanner API.type: docsImprovement to the documentation for an API.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions