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

Update Atomic Distributed Transaction Design #17005

Merged
merged 8 commits into from
Nov 12, 2024

Conversation

harshit-gangal
Copy link
Member

@harshit-gangal harshit-gangal commented Oct 18, 2024

Description

This PR updated the Atomic Distributed Transaction design document.

Related Issue(s)

Checklist

  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Copy link
Contributor

vitess-bot bot commented Oct 18, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Oct 18, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Oct 18, 2024
Signed-off-by: Harshit Gangal <[email protected]>
Copy link

codecov bot commented Oct 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.40%. Comparing base (0fa7e58) to head (6034ead).
Report is 74 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17005      +/-   ##
==========================================
- Coverage   69.34%   67.40%   -1.94%     
==========================================
  Files        1571     1570       -1     
  Lines      204180   252892   +48712     
==========================================
+ Hits       141582   170457   +28875     
- Misses      62598    82435   +19837     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Harshit Gangal <[email protected]>
Signed-off-by: Harshit Gangal <[email protected]>
@harshit-gangal harshit-gangal added Type: Documentation Component: Query Serving and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Oct 19, 2024
doc/design-docs/TwoPhaseCommitDesign.md Outdated Show resolved Hide resolved
Signed-off-by: Harshit Gangal <[email protected]>
@systay
Copy link
Collaborator

systay commented Nov 8, 2024

Throughout the document, there are varying uses of terms like “vttablet,” “VTTablet,” “vtgate,” and “VTGate.” It would be better to standardize these terms for consistency. Use “VTTablet” and “VTGate” uniformly.
Also - use lowercase consistently when referring to commands and flags (e.g., transaction_mode=twopc).

Signed-off-by: Harshit Gangal <[email protected]>
@harshit-gangal harshit-gangal merged commit d512393 into vitessio:main Nov 12, 2024
99 checks passed
@harshit-gangal harshit-gangal deleted the twopc-design branch November 12, 2024 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants