Skip to content

i18n(ja): unify execution plan cache notation - #23807

Open
yahonda wants to merge 4 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-plan-cache-execution-notation
Open

i18n(ja): unify execution plan cache notation#23807
yahonda wants to merge 4 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-plan-cache-execution-notation

Conversation

@yahonda

@yahonda yahonda commented Sep 10, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Unifies a same-file, same-EN-phrase notation split for "execution plan cache": most occurrences use 実行プランキャッシュ, but several use 実行計画キャッシュ or a stray-space variant 実行計画 キャッシュ for the exact same EN wording (verified against release-8.5 line-by-line). Also reconstructs a word-order-scrambled sentence in tidb-performance-tuning-config.md listing the same feature.

Bare "plan cache" (プランキャッシュ, without 実行) is intentionally left untouched — it correctly mirrors EN's own separate, more casual "plan cache" wording used in generic prose and dashboard-panel names (e.g. "Queries Using Plan Cache OPS"), which is a distinct rendering from "execution plan cache", not an inconsistency.

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

  • i18n-ja-release-8.5 (TiDB Japanese documentation for TiDB 8.5 versions)

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

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

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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

Summary by CodeRabbit

  • Documentation
    • Standardized Japanese terminology for execution plan caches across performance, SQL, system-variable, cloud integration, and release documentation.
    • Corrected spacing, grammar, and punctuation in plan-cache descriptions.
    • Aligned the Grafana metric label with the adjacent avg-miss label.
    • Clarified plan-cache configuration guidance, including prepared, non-prepared, and instance-level caches.
    • Documented TiDB Lightning prepared-statement and client-side statement-caching support when enabled.

@ti-chi-bot

ti-chi-bot Bot commented Sep 10, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@ti-chi-bot ti-chi-bot Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 10, 2026
@coderabbitai

coderabbitai Bot commented Sep 10, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Warning

Review limit reached

Next included review available in 25 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 4 included reviews currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 8cbcdce0-e14d-4ec4-bdd1-02eaaa47af07

📥 Commits

Reviewing files that changed from the base of the PR and between 645c2ff and 3875cb6.

📒 Files selected for processing (10)
  • grafana-performance-overview-dashboard.md
  • releases/release-7.0.0.md
  • releases/release-8.2.0.md
  • releases/release-8.4.0.md
  • sql-prepared-plan-cache.md
  • system-variables.md
  • tidb-cloud/monitor-datadog-integration-for-tidb-x.md
  • tidb-cloud/monitor-datadog-integration.md
  • tidb-cloud/monitor-new-relic-integration.md
  • tidb-performance-tuning-config.md

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 7537ecdd-52f0-4416-a874-13301b4f271b

📥 Commits

Reviewing files that changed from the base of the PR and between ad9868c and 6514317.

📒 Files selected for processing (1)
  • tidb-performance-tuning-config.md

Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.


📝 Walkthrough

Walkthrough

The changes standardize Japanese plan cache terminology across performance, monitoring, system-variable, configuration, and release documentation. They also rename one Grafana metric label and document logical-import prepared statement support.

Changes

Plan Cache Documentation

Layer / File(s) Summary
Core terminology updates
performance-tuning-methods.md, performance-tuning-practices.md, sql-prepared-plan-cache.md, system-variables.md, tidb-performance-tuning-config.md
Standardized plan cache terminology and corrected Japanese wording in performance, prepared plan cache, system-variable, and configuration documentation.
Observability metric descriptions
grafana-performance-overview-dashboard.md, tidb-cloud/monitor-*.md
Renamed the Grafana hit metric label to avg-hit and updated plan cache metric descriptions in Grafana, Datadog, and New Relic documentation.
Release-note terminology
releases/release-7.0.0.md, releases/release-8.2.0.md, releases/release-8.4.0.md
Corrected plan cache spacing and terminology. Added documentation for TiDB Lightning logical imports using prepared statements and client-side statement caching when logical-import-prep-stmt is enabled.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Severity of issue fixed: Low

Merge Risk: 🟡 Moderate · up to 65143

This change standardizes Japanese plan-cache terminology, but the documentation still has unresolved ambiguity around cache-mode enablement and several wording inconsistencies. Those could lead users to misinterpret plan-cache behavior or configuration guidance, so clarification is needed before merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the primary change: standardizing Japanese execution plan cache terminology. It is concise and directly related to the documentation updates.
Description check ✅ Passed The description includes the required change summary, affected version, reference-link section, AI involvement, and change-type checklist. It clearly explains the terminology changes and the intention…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Sep 10, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 10, 2026

Copy link
Copy Markdown

[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 assign lilin90 for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

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

Details 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 size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 10, 2026
@yahonda
yahonda marked this pull request as ready for review September 10, 2026 00:51
@ti-chi-bot ti-chi-bot Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 10, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 4


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 861c6c5e-acb7-4c47-ac40-5a362b8d199f

📥 Commits

Reviewing files that changed from the base of the PR and between a2da298 and 144f2d2.

📒 Files selected for processing (12)
  • grafana-performance-overview-dashboard.md
  • performance-tuning-methods.md
  • performance-tuning-practices.md
  • releases/release-7.0.0.md
  • releases/release-8.2.0.md
  • releases/release-8.4.0.md
  • sql-prepared-plan-cache.md
  • system-variables.md
  • tidb-cloud/monitor-datadog-integration-for-tidb-x.md
  • tidb-cloud/monitor-datadog-integration.md
  • tidb-cloud/monitor-new-relic-integration.md
  • tidb-performance-tuning-config.md

Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.

Comment thread sql-prepared-plan-cache.md Outdated
Comment thread sql-prepared-plan-cache.md Outdated
Comment thread system-variables.md Outdated
Comment thread tidb-performance-tuning-config.md Outdated
TiDBのパフォーマンスを最適化するために、一般的に以下の設定が使用されます。

- [SQLプリペアドプランキャッシュ](/sql-prepared-plan-cache.md)などの実行プランキャッシュ[非プリペアドプランキャッシュ](/sql-non-prepared-plan-cache.md)強化します[インスタンスレベルの実行プランキャッシュ](/system-variables.md#tidb_enable_instance_plan_cache-new-in-v840)
- [SQLプリペアドプランキャッシュ](/sql-prepared-plan-cache.md)[非プリペアドプランキャッシュ](/sql-non-prepared-plan-cache.md)[インスタンスレベルの実行プランキャッシュ](/system-variables.md#tidb_enable_instance_plan_cache-new-in-v840)など、実行プランキャッシュを強化します。

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🗄️ Data Integrity & Integration | 🟠 Major | 🏗️ Heavy lift

Align the cache-mode guidance across the documents.

This new bullet groups the session prepared cache, session non-prepared cache, and instance-level cache as one recommendation. The SQL block below enables tidb_enable_instance_plan_cache and tidb_enable_non_prepared_plan_cache together. However, system-variables.md recommends disabling session-level prepared and non-prepared caches before enabling the instance-level cache. The documentation gives conflicting operational guidance.

Update the bullet, SQL block, and variable table so they describe one supported combination, or clearly mark the cache modes as alternatives.

As per path instructions, this fix spans noncontiguous Markdown content and requires the supported cache-mode decision, so a committable replacement is not safe here.

Source: Path instructions

@yahonda yahonda changed the title i18n(ja): unify 実行計画キャッシュ notation to 実行プランキャッシュ i18n(ja): unify execution plan cache notation Sep 10, 2026
@yahonda
yahonda force-pushed the fix-plan-cache-execution-notation branch from 144f2d2 to ad9868c Compare September 10, 2026 00:59
@qiancai qiancai added translation/no-need No need to translate this PR. and removed missing-translation-status This PR does not have translation status info. labels Sep 10, 2026
@yahonda
yahonda force-pushed the fix-plan-cache-execution-notation branch 2 times, most recently from d8355f2 to 0c8be8e Compare September 10, 2026 05:52
Unify 実行計画キャッシュ/実行計画 キャッシュ to 実行プランキャッシュ
where all three forms translate the same EN phrase "execution plan
cache" for the same referent.
EN "Still, use the preceding statement as an example:" uses "Still" to
mean "continuing with the same example", not a contrast. ただし
(however) wrongly implied a contrast that isn't in the source.
…config.md

EN links to this page as "SQL Prepared Execution Plan Cache" (capitalized
proper noun), while the adjacent "Non-prepared plan cache" link stays
lowercase in EN -- so only the first link gains the qualifier, matching
each site's own EN capitalization, consistent with pingcap#23809.
@yahonda
yahonda force-pushed the fix-plan-cache-execution-notation branch from 0c8be8e to 2df5ece Compare September 11, 2026 00:10
…bit review

- describe the retrieved plan, not the plan cache, as the object
  retrieved from the cache
- align the clear-execution-plan-cache heading and its trailing
  sentence to the same 実行プランキャッシュ/実行プラン terms used
  throughout the section
- drop a stray 実行 in the non-prepared-plan-cache warning so it
  matches the surrounding 非プリペアドプランキャッシュ wording

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@yahonda

yahonda commented Sep 11, 2026

Copy link
Copy Markdown
Member Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Sep 11, 2026

Copy link
Copy Markdown
⚠️ Action not completed

Review rate limited.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants