Skip to content

Commit

Permalink
Add docs for "transaction deadline exceeded" error
Browse files Browse the repository at this point in the history
Fixes #4552.

Summary of changes:

- Update 'Common Errors' page with the retry error message, and
  recommend the user add retries to their app.
  • Loading branch information
rmloveland committed Apr 15, 2019
1 parent 693a85e commit 46869d0
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions v19.1/common-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ Messages with the error code `40001` and the string `restart transaction` indica
The sections below describe different types of transaction retry errors. Your application's retry logic does not need to distinguish between these types of errors; they are listed here for reference.

- [read within uncertainty interval](#read-within-uncertainty-interval)
- [transaction deadline exceeded](#transaction-deadline-exceeded)

### read within uncertainty interval

Expand All @@ -73,6 +74,12 @@ When errors like this occur, the application has the following options:
Uncertainty errors are a form of transaction conflict. For more information about transaction conflicts, see [Transaction conflicts](architecture/transaction-layer.html#transaction-conflicts).
{{site.data.alerts.end}}

### transaction deadline exceeded

<span class="version-tag">New in v19.1</span>: Errors of type "transaction deadline exceeded", which were reported to the client as an opaque `TransactionStatusError` in previous versions of CockroachDB, are now considered retryable, and paired with the error code `4001`. Such errors can occur during long-running transactions (on the order of minutes) when transactions are pushed in the transaction queue, which is necessary to maintain [serializable isolation](https://en.wikipedia.org/wiki/Isolation_(database_systems)#Serializable).

When this error occurs, the application must retry the transaction. For more information about how to retry transactions, see [Transaction retries](transactions.html#transaction-retries).

<!-- ### write too old -->

<!-- ### async write failure -->
Expand Down

0 comments on commit 46869d0

Please sign in to comment.