feat: support statement_timeout and transaction_timeout property #578
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
olavloite
force-pushed
the
statement-timeout
branch
2 times, most recently
from
80dbaa0 to
0d69f22
Compare
olavloite
changed the title
olavloite
force-pushed
the
statement-timeout
branch
8 times, most recently
from
1791559 to
4667c42
Compare
This was referenced Oct 27, 2025
olavloite
force-pushed
the
statement-timeout
branch
2 times, most recently
from
1b7b5f0 to
1fc9908
Compare
Add a statement_timeout connection property that is used as the default timeout for the execution of all statements that are executed on a connection. The timeout is only used for the actual execution, and not attached to the iterator that is returned for a query. This also means that a query that is executed without the DirectExecuteQuery option, will ignore the statement_timeout value. Also adds a transaction_timeout property that is additionally used for all statements in a read/write transaction. The deadline of the transaction is calculated at the start of the transaction, and all statements in the transaction get this deadline, unless the statement already has an earlier deadline from for example a statement_timeout or a context deadline. This change also fixes some issues with deadlines when using the gRPC API of SpannerLib. The context that is used for an RPC invocation is cancelled after the RPC has finished. This context should therefore not be used as the context for any query execution, as the context is attached to the row iterator, and would cancel the query execution halfway. Fixes #574 Fixes #575
olavloite
force-pushed
the
statement-timeout
branch
from
1fc9908 to
5ae4187
Compare
olavloite
requested review from
aakashanandg,
bhatt4982,
rahul2393 and
rayudu3745
bhatt4982
reviewed
Oct 31, 2025
conn.go
Outdated
| // one error. This will preserve the DeadlineExceeded error code from statementErr, and include the request | ||
| // ID from the Spanner error. | ||
| s := status.FromContextError(statementErr) | ||
| return fmt.Errorf("%w: %w", s.Err(), res.dirtyErr) |
There was a problem hiding this comment.
Could you check this... fmt.Errorf allows at most one %w verb. Using two %w will cause a runtime panic: "fmt: multiple %w verbs in format".
return fmt.Errorf("%v: %w", s.Err(), res.dirtyErr)
There was a problem hiding this comment.
Hmmm... Interesting point. This was actually changed in Go 1.20: https://go.dev/doc/go1.20#errors
So anyone using the correct minimum version of Go should not run into that problem. But a safer way to solve this might be to just use the errors.Join function, as that would then give a compile-time error instead of a runtime panic.
aakashanandg
pushed a commit
to aakashanandg/go-sql-spanner
that referenced
this pull request
Oct 31, 2025
…gleapis#578) * feat: support statement_timeout and transaction_timeout property Add a statement_timeout connection property that is used as the default timeout for the execution of all statements that are executed on a connection. The timeout is only used for the actual execution, and not attached to the iterator that is returned for a query. This also means that a query that is executed without the DirectExecuteQuery option, will ignore the statement_timeout value. Also adds a transaction_timeout property that is additionally used for all statements in a read/write transaction. The deadline of the transaction is calculated at the start of the transaction, and all statements in the transaction get this deadline, unless the statement already has an earlier deadline from for example a statement_timeout or a context deadline. This change also fixes some issues with deadlines when using the gRPC API of SpannerLib. The context that is used for an RPC invocation is cancelled after the RPC has finished. This context should therefore not be used as the context for any query execution, as the context is attached to the row iterator, and would cancel the query execution halfway. Fixes googleapis#574 Fixes googleapis#575 * chore: use errors.Join instead of two %w verbs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a statement_timeout connection property that is used as the default timeout
for all statements that are executed on a connection. If both a context timeout
and a statement_timeout is specified, then the lower of the two will be used.
Also adds a transaction_timeout property that is additionally used for all
statements in a read/write transaction. The deadline of the transaction is
calculated at the start of the transaction, and all statements in the transaction
get this deadline, unless the statement already has an earlier deadline from
for example a statement_timeout or a context deadline.
Fixes #574
Fixes #575