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

tikv-in-memory-engine: Add link to config and extend docs #20293

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

dveeden
Copy link
Contributor

@dveeden dveeden commented Feb 14, 2025

What is changed, added or deleted? (Required)

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

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

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

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 14, 2025
@dveeden dveeden force-pushed the in_memory_link_to_config branch from 70a67d5 to 8cd857d Compare February 14, 2025 06:41
@ti-chi-bot ti-chi-bot bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 14, 2025
@dveeden dveeden changed the title tikv-in-memory-engine: Add link to config tikv-in-memory-engine: Add link to config and extend docs Feb 14, 2025
Copy link
Member

@overvenus overvenus left a comment

Choose a reason for hiding this comment

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

Thank you!

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Feb 14, 2025
@qiancai qiancai self-assigned this Feb 24, 2025
glossary.md Outdated
Comment on lines 167 to 169
### IME

The IME abbreviation is for [TiKV MVCC In-Memory Engine](/tikv-in-memory-engine.md).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
### IME
The IME abbreviation is for [TiKV MVCC In-Memory Engine](/tikv-in-memory-engine.md).
### TiKV MVCC In-Memory Engine (IME)
[TiKV MVCC In-Memory Engine](/tikv-in-memory-engine.md) (IME) caches the latest written MVCC versions in memory and implements an MVCC GC mechanism independent of TiDB to accelerate queries involving a large number of MVCC historical versions.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is the ordering still right if we change this?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Good catch! After this change, we need to move this term to the ## T section.

Co-authored-by: Grace Cai <qqzczy@126.com>
Copy link

ti-chi-bot bot commented Feb 24, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from qiancai, ensuring that each of them provides their approval before proceeding. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

dveeden and others added 3 commits February 24, 2025 07:52
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
@qiancai qiancai added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. and removed missing-translation-status This PR does not have translation status info. labels Feb 24, 2025
Comment on lines +438 to +441
- Oldest Auto GC SafePoint: The oldest automatic GC safe point for Regions cached in the in-memory engine
- Newest Auto GC SafePoint: The newest automatic GC safe point for Regions cached in the in-memory engine
- Auto GC SafePoint Gap: The time gap between the newest automatic GC safe point and the oldest automatic GC safe point for Regions cached in the in-memory engine
- Auto GC SafePoint Gap With TiKV: The gap between the TiKV automatic GC safe point and the oldest automatic GC safe point for Regions cached in the in-memory engine
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- Oldest Auto GC SafePoint: The oldest automatic GC safe point for Regions cached in the in-memory engine
- Newest Auto GC SafePoint: The newest automatic GC safe point for Regions cached in the in-memory engine
- Auto GC SafePoint Gap: The time gap between the newest automatic GC safe point and the oldest automatic GC safe point for Regions cached in the in-memory engine
- Auto GC SafePoint Gap With TiKV: The gap between the TiKV automatic GC safe point and the oldest automatic GC safe point for Regions cached in the in-memory engine
- Oldest Auto GC SafePoint: The oldest automatic GC safepoint for Regions cached in the in-memory engine
- Newest Auto GC SafePoint: The newest automatic GC safepoint for Regions cached in the in-memory engine
- Auto GC SafePoint Gap: The time gap between the newest automatic GC safepoint and the oldest automatic GC safepoint for Regions cached in the in-memory engine
- Auto GC SafePoint Gap With TiKV: The gap between the TiKV automatic GC safepoint and the oldest automatic GC safepoint for Regions cached in the in-memory engine


### How can I check whether the TiKV MVCC in-memory engine is enabled?

You can check the TiKV configuration using the [`SHOW CONFIG`](/sql-statements/sql-statement-show-config.md) statement.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
You can check the TiKV configuration using the [`SHOW CONFIG`](/sql-statements/sql-statement-show-config.md) statement.
You can check the TiKV configuration using the [`SHOW CONFIG`](/sql-statements/sql-statement-show-config.md) statement. If the value of `in-memory-engine.enable` is `true`, it means that TiKV MVCC in-memory engine is enabled.

@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Feb 25, 2025
Copy link

ti-chi-bot bot commented Feb 25, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-02-14 06:47:56.73864073 +0000 UTC m=+598319.134862812: ☑️ agreed by overvenus.
  • 2025-02-25 03:11:36.526624572 +0000 UTC m=+325444.479782835: ☑️ agreed by hfxsd.

dveeden and others added 2 commits February 25, 2025 07:25
Co-authored-by: xixirangrang <hfxsd@hotmail.com>
Co-authored-by: xixirangrang <hfxsd@hotmail.com>
Copy link

ti-chi-bot bot commented Feb 25, 2025

@dveeden: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-verify fb8dfa2 link true /test pull-verify

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants