Docs(Clients): Document transaction abort reason categories#761
Open
rahst12 wants to merge 1 commit into
Open
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
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.
Description
Documents the new transaction abort reason categories that Dgraph reports to clients,
across the shared concept page and each client page.
When a commit aborts, the server now encodes why as a
"<code>: <detail>"prefix on thegRPC
ABORTEDstatus (and the HTTP error message), with<code>being one ofconflict,stale-startts, orpredicate-move. This PR explains that format and the per-languageAPI:
clients/index.md— new "Abort reasons" subsection: the three categories, themessage format, and graceful degradation to
UNKNOWNagainst older servers.clients/java.md— "Handling aborted transactions" usingTxnConflictException.getReason()/AbortReason.clients/python.md— parallel section forpydgraph.AbortedError.reason/pydgraph.AbortReason.clients/raw-http.md— updated abort response example plus a table of the codes.All four pages cross-link via the shared
#abort-reasonsanchor. Content is additive anddescriptive only.
Related PRs
Unreleased feature
corresponding server and client releases are out.