Skip to content

add in-memory-engine config items #21044

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

Merged
merged 3 commits into from
May 27, 2025

Conversation

hfxsd
Copy link
Collaborator

@hfxsd hfxsd commented May 27, 2025

First-time contributors' checklist

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)?

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
@hfxsd hfxsd self-assigned this May 27, 2025
@hfxsd hfxsd requested a review from qiancai May 27, 2025 03:04
@ti-chi-bot ti-chi-bot bot added the contribution This PR is from a community contributor. label May 27, 2025
@hfxsd hfxsd requested a review from overvenus May 27, 2025 03:04
@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 May 27, 2025
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Hello @hfxsd, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

Hello! Gemini/gemini-code-assist here, providing a summary of this pull request. This PR, authored by hfxsd, aims to add documentation for new configuration items related to the in-memory-engine feature in TiKV. The changes specifically update the release notes for version 8.5.0 to include details about four new configuration parameters that control the behavior and resource usage of this in-memory engine.

Highlights

  • Documentation for In-Memory Engine Configs: This pull request adds documentation entries for new TiKV configuration items related to the in-memory-engine feature. These configurations control aspects like memory capacity, enabling the feature, garbage collection intervals, and MVCC amplification thresholds.
  • Release Notes Update: The documentation is added to the release notes file for TiDB version 8.5.0, specifically within the table summarizing new and modified configuration items.

Changelog

  • releases/release-8.5.0.md
    • Added entries for four new TiKV configuration items related to the in-memory-engine (capacity, enable, gc-run-interval, mvcc-amplification-threshold) to the v8.5.0 release notes table.
    • The new entries are inserted between the existing raft-client-queue-size and patrol-region-worker-count entries in the table.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@hfxsd hfxsd added translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. and removed contribution This PR is from a community contributor. 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 May 27, 2025
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

Thanks for adding the new in-memory-engine configuration items to the release notes! The descriptions are mostly clear and follow the existing format well. I have one suggestion to improve the clarity of the gc-run-interval description.

Summary of Findings

  • Clarity of in-memory-engine.gc-run-interval description: The description for in-memory-engine.gc-run-interval uses the phrase 'GC caches MVCC versions', which could be confusing. Suggested rephrasing for better clarity and consistency: 'Controls the time interval for the in-memory engine to GC the cached MVCC versions.'

Merge Readiness

The pull request is in good shape and clearly documents the new configuration items. There's one minor suggestion for improving the clarity of a description, which can be addressed easily. As per the repository's style guide, I am providing comments rather than requesting changes to avoid blocking the merge. I am not authorized to approve pull requests; please ensure further review and approval as per your team's process before merging.

@ti-chi-bot ti-chi-bot bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label May 27, 2025
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Copy link
Collaborator

@qiancai qiancai 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

Copy link
Collaborator

@qiancai qiancai 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

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label May 27, 2025
Co-authored-by: Grace Cai <qqzczy@126.com>
@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels May 27, 2025
Copy link

ti-chi-bot bot commented May 27, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-05-27 04:11:02.870565413 +0000 UTC m=+328593.242352871: ☑️ agreed by qiancai.
  • 2025-05-27 04:58:58.271667777 +0000 UTC m=+331468.643455226: ☑️ agreed by overvenus.
@hfxsd
Copy link
Collaborator Author

hfxsd commented May 27, 2025

/approve

Copy link

ti-chi-bot bot commented May 27, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hfxsd

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

The pull request process is described 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

@ti-chi-bot ti-chi-bot bot added the approved label May 27, 2025
@ti-chi-bot ti-chi-bot bot merged commit 4ddaeca into pingcap:master May 27, 2025
8 of 9 checks passed
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #21051.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved lgtm needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn.
4 participants