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

*: refactor transaction documents #2088

Merged
merged 18 commits into from
Apr 3, 2020

Conversation

anotherrachel
Copy link
Contributor

@anotherrachel anotherrachel commented Mar 24, 2020

What is changed, added or deleted? (Required)

Original PR: #1695 (closed)

This PR refactors and updates transaction-related documents, including:

  • Split and merge the current Optimistic Locking best practice doc into existing Transaction Documents (because it is not a best practice doc, rather, it is a compilation of existing content on transactions.)
  • The Transaction Overview doc include content applicable to both Optimistic Transaction and Pessimistic Transaction
  • The previous Transaction Model is now changed to Optimistic Transaction

Version differences: pingcap/docs-cn#2255

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version, including v4.0 changes for now)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

If you select two or more versions from above, to trigger the bot to cherry-pick this PR to your desired release version branch(es), you must add corresponding labels such as needs-cherry-pick-3.1, needs-cherry-pick-3.0, and needs-cherry-pick-2.1.

What is the related PR or file link(s)?

@anotherrachel anotherrachel added type/refactor The issue belongs to a refactor work. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. size/large Changes of a large size. needs-cherry-pick-2.1 labels Mar 24, 2020
@anotherrachel anotherrachel added the requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. label Mar 24, 2020
@anotherrachel anotherrachel marked this pull request as ready for review March 25, 2020 06:16
@anotherrachel anotherrachel removed the translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. label Mar 25, 2020
@anotherrachel
Copy link
Contributor Author

@youjiali1995 PTAL

@anotherrachel
Copy link
Contributor Author

@TomShawn @yikeke PTAL

@@ -26,7 +26,7 @@ We believe that being able to replicate in both directions lowers the risk when

TiDB internally shards table into small range-based chunks that we refer to as "Regions". Each Region defaults to approximately 100MiB in size, and TiDB uses a Two-phase commit internally to ensure that Regions are maintained in a transactionally consistent way.

Transactions in TiDB are strongly consistent, with snapshot isolation level consistency. For more information, see transaction [behavior and performance differences](/reference/transactions/transaction-model.md). This makes TiDB more comparable to traditional relational databases in semantics than some of the newer NoSQL systems using eventual consistency.
Transactions in TiDB are strongly consistent, with snapshot isolation level consistency. For more information, see transaction [behavior and performance differences](/reference/transactions/transaction-isolation.md). This makes TiDB more comparable to traditional relational databases in semantics than some of the newer NoSQL systems using eventual consistency.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is irrelevant to the Chinese version.
Generally, I will replace transaction-model.md(now deleted) with transaction-optimistic.md. But here, according to the context, I replace it with transaction-isolation.md.

Copy link

@youjiali1995 youjiali1995 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. But it doesn't apply to v2.1.

@anotherrachel
Copy link
Contributor Author

LGTM. But it doesn't apply to v2.1.

Sure. I will make dedicated changes when this PR is merged. Thanks!

glossary.md Outdated Show resolved Hide resolved
glossary.md Outdated Show resolved Hide resolved
glossary.md Outdated Show resolved Hide resolved
glossary.md Show resolved Hide resolved
reference/transactions/overview.md Outdated Show resolved Hide resolved
reference/transactions/overview.md Outdated Show resolved Hide resolved
reference/transactions/overview.md Outdated Show resolved Hide resolved
reference/transactions/overview.md Outdated Show resolved Hide resolved
reference/transactions/overview.md Outdated Show resolved Hide resolved
reference/transactions/overview.md Outdated Show resolved Hide resolved
reference/transactions/overview.md Outdated Show resolved Hide resolved
reference/transactions/overview.md Outdated Show resolved Hide resolved
reference/transactions/overview.md Outdated Show resolved Hide resolved
reference/transactions/overview.md Outdated Show resolved Hide resolved
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
@anotherrachel
Copy link
Contributor Author

@yikeke PTAL

Copy link
Contributor

@yikeke yikeke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rest LGTM

reference/transactions/transaction-optimistic.md Outdated Show resolved Hide resolved
reference/transactions/transaction-optimistic.md Outdated Show resolved Hide resolved
reference/transactions/transaction-optimistic.md Outdated Show resolved Hide resolved
reference/transactions/transaction-optimistic.md Outdated Show resolved Hide resolved
Copy link
Contributor

@yikeke yikeke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@anotherrachel anotherrachel merged commit cbc27e0 into pingcap:master Apr 3, 2020
sre-bot pushed a commit to sre-bot/docs that referenced this pull request Apr 3, 2020
Signed-off-by: sre-bot <sre-bot@pingcap.com>
@sre-bot
Copy link
Contributor

sre-bot commented Apr 3, 2020

cherry pick to release-2.1 in PR #2156

sre-bot pushed a commit to sre-bot/docs that referenced this pull request Apr 3, 2020
Signed-off-by: sre-bot <sre-bot@pingcap.com>
@sre-bot
Copy link
Contributor

sre-bot commented Apr 3, 2020

cherry pick to release-3.0 in PR #2157

sre-bot pushed a commit to sre-bot/docs that referenced this pull request Apr 3, 2020
Signed-off-by: sre-bot <sre-bot@pingcap.com>
@sre-bot
Copy link
Contributor

sre-bot commented Apr 3, 2020

cherry pick to release-3.1 in PR #2158

sre-bot added a commit that referenced this pull request Apr 3, 2020
Signed-off-by: sre-bot <sre-bot@pingcap.com>
sre-bot added a commit that referenced this pull request Apr 3, 2020
Signed-off-by: sre-bot <sre-bot@pingcap.com>
jackysp pushed a commit to jackysp/docs that referenced this pull request Apr 15, 2020
* tools: add br tool doc and refine mydumper/loader doc

* tools: add diagram

* tools: adjust image size

* tools: refine language

* tools: refine language

* maintain: update content

* maintain: refine language

* maintain: fix a typo

* maintain: add working principles

* maintain: refine introduction

* maintain: refine format and layout

* maintain: address comments from pingcap#2088

* maintainL refine language

* maintain: minor language change

* address comments

* address comments

* address comments

* maintain: fix a typo

* maintain: fix grammar error

* maintain: fix a typo
@anotherrachel anotherrachel deleted the refactor-transaction branch April 16, 2020 02:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
requires-version-specific-changes After cherry-picked, the cherry-picked PR requires further changes. size/large Changes of a large size. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. type/refactor The issue belongs to a refactor work.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants