Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

High level documentation #5

Closed
13 tasks
nrc opened this issue Jun 7, 2020 · 1 comment
Closed
13 tasks

High level documentation #5

nrc opened this issue Jun 7, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@nrc
Copy link
Collaborator

nrc commented Jun 7, 2020

These things are not code-specific and span TiKV and its client. They would be best documented in a separate docs area, rather than inline in the code, and/or in blog posts.

  • Transactions overview, data format, latches, MVCC (TiDB docs, TinyKV docs, Xuelian's blog, VLDB paper)
  • Optimistic locking
  • Pessimistic locking (blog post)
  • Isolation/consistency properties (Jepsen report)
  • Lock management/waiter mangement, deadlock detection
  • GC, green GC
  • Pipelined pessimistic locking
  • Large transactions (blog post)
  • Parallel commit (repo)
  • 1pc
  • Replica read (aka follower read)
  • Timestamps and HLC
  • Alternatives
@nrc nrc added the documentation Improvements or additions to documentation label Jun 7, 2020
@nrc
Copy link
Collaborator Author

nrc commented Jun 25, 2020

Closing in favour of the docs quest (#25)

@nrc nrc closed this as completed Jun 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant