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

metadata-lock: small fixes #20714

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

metadata-lock: small fixes #20714

wants to merge 2 commits into from

Conversation

dveeden
Copy link
Contributor

@dveeden dveeden commented Apr 3, 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):

Needs to be merged into v8.5 after #20705 is merged

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

@dveeden dveeden requested review from hfxsd and Oreoxmt April 3, 2025 08:20
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 @dveeden, 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

This pull request addresses two small issues related to the metadata-lock.md documentation. First, it corrects a reference in the example DDL statement from ALTER TABLE t ADD INDEX idx(a) to ALTER TABLE t ADD COLUMN c INT. Second, it clarifies that mysql.tidb_mdl_view is a view, not a base table, in mysql-schema/mysql-schema-tidb-mdl-view.md. The changes are applied to the master, v9.0, and v8.5 branches.

Highlights

  • Documentation Fix: Corrects the example DDL statement in metadata-lock.md to use ADD COLUMN instead of ADD INDEX.
  • Clarification: Clarifies that mysql.tidb_mdl_view is a view, not a table, in mysql-schema/mysql-schema-tidb-mdl-view.md.

Changelog

  • metadata-lock.md
    • Corrects the example DDL statement from adding an index to adding a column.
  • mysql-schema/mysql-schema-tidb-mdl-view.md
    • Clarifies that mysql.tidb_mdl_view is a view, not a 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.


A view's facade,
A lock's hidden decree,
Docs now aligned.

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.

@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 Apr 3, 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

The pull request addresses two issues: clarifying that mysql.tidb_mdl_view is a view and not a base table, and fixing a typo in an example. The changes are small and focused.

Summary of Findings

  • Clarity of mysql.tidb_mdl_view: The changes clearly indicate that mysql.tidb_mdl_view is a view, which improves the accuracy of the documentation.
  • Typo in example: The correction of 'index' to 'column' in the example enhances the correctness and understandability of the documentation.

Merge Readiness

The pull request is ready to be merged. The changes are straightforward and improve the accuracy and clarity of the documentation. I am unable to directly approve the pull request, and that users should have others review and approve this code before merging.

@dveeden dveeden mentioned this pull request Apr 3, 2025
16 tasks
@dveeden
Copy link
Contributor Author

dveeden commented Apr 3, 2025

The vale CI error doesn't look related to this PR

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 Apr 5, 2025
Copy link

ti-chi-bot bot commented Apr 5, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-04-05 10:46:46.247310422 +0000 UTC m=+1907699.931546519: ☑️ agreed by qiancai.

@qiancai qiancai self-assigned this Apr 5, 2025
Co-authored-by: Grace Cai <[email protected]>
Copy link

ti-chi-bot bot commented Apr 5, 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
missing-translation-status This PR does not have translation status info. needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants