Skip to content

Conversation

@dveeden
Copy link
Contributor

@dveeden dveeden commented Dec 24, 2025

First-time contributors' checklist

What is changed, added or deleted? (Required)

Add documentation for UUID_V4(), UUID_V7(), UUID_VERSION() and UUID_TIMESTAMP().

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.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):

pingcap/tidb#65007

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

@gemini-code-assist
Copy link

Summary of Changes

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!

This pull request significantly expands the documentation for TiDB's UUID-related functions. It introduces detailed explanations, usage examples, and references for UUID_V4(), UUID_V7(), UUID_VERSION(), and UUID_TIMESTAMP(), while also clarifying the behavior of the existing UUID() function. This update ensures users have clear and up-to-date information on generating and working with various UUID versions within TiDB.

Highlights

  • New UUID Functions Documented: Added comprehensive documentation for the UUID_V4(), UUID_V7(), UUID_VERSION(), and UUID_TIMESTAMP() functions, enhancing the clarity and completeness of TiDB's UUID capabilities.
  • Function Table Update: The miscellaneous functions table has been updated to include the newly documented UUID functions, making them discoverable within the function list.
  • UUID() Function Clarification: The existing UUID() function's description was updated to explicitly state it returns a version 1 UUID and references the latest RFC 9562.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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.

@ti-chi-bot
Copy link

ti-chi-bot bot commented Dec 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 assign breezewish 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 missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 24, 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

This pull request adds valuable documentation for the new UUID functions (UUID_V4, UUID_V7, UUID_VERSION, UUID_TIMESTAMP). The new content is well-structured and informative. I've provided a few suggestions to enhance clarity, ensure consistency, and correct a minor copy-paste error, all in accordance with the repository's documentation style guide. My feedback primarily focuses on reordering items for better discoverability and rephrasing sentences for improved readability.

dveeden and others added 3 commits December 24, 2025 18:57
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@dveeden dveeden requested review from hfxsd, lilin90 and mjonss December 24, 2025 18:35
@dveeden
Copy link
Contributor Author

dveeden commented Dec 24, 2025

@gemini-code-assist any more recommendations?

@gemini-code-assist
Copy link

Thanks for asking, @dveeden! I've taken a closer look at the changes, and this is a great addition to the documentation, significantly enhancing the clarity and completeness of TiDB's UUID capabilities. The examples provided are very helpful for understanding the new functions.

I have a few minor recommendations for further improvement:

  • Consistency in Terminology: Ensure consistent use of "UUIDs" (plural) instead of "UUID's" (possessive) where appropriate.
  • Typographical Corrections: A couple of minor typos were found.
  • Clarity in Function Descriptions: A small suggestion to make one function description slightly more precise.

Here are the specific suggestions:


File: best-practices/uuid.md

  • Line 24: "UUID's" should be "UUIDs".
[RFC 9562](https://datatracker.ietf.org/doc/html/rfc9562) defines 8 different versions of UUIDs. TiDB can store any version of UUID and can create v1, v4 and v7 UUIDs.
  • Line 32: "creatad" should be "created".
UUIDv4 is created with the [`UUID_V4()`](/functions-and-operators/miscellaneous-functions.md#uuid_v4) function. This function does not store a timestamp and is fully random except for the bits that store the version and variant.
  • Line 36: "modern aternative" should be "modern alternative".
UUIDv6 is a modern alternative to UUIDv1 that is field compatible with UUIDv1.
  • Line 37: "functions" should be "function".

  • Line 38: For consistency, consider using "UUIDv1" instead of "version 1 UUID" here, as you use "UUIDv7" later in the same sentence.

UUIDv7 is created with the [`UUID_V7()`](/functions-and-operators/miscellaneous-functions.md#uuid_v7) function. This function is meant as a modern alternative to UUIDv1 for applications that don't require a UUID that is field compatible.

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. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant