Add FORMAT_BYTES and FORMAT_NANO_TIME functions (#20872) #21192
Conversation
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>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
There was a problem hiding this comment.
Summary of Changes
Hello @ti-chi-bot, 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 focuses on enhancing the TiDB documentation by introducing a new section for utility functions. Specifically, it adds documentation for FORMAT_BYTES() and FORMAT_NANO_TIME(), which are designed to improve data readability by converting raw byte counts and nanosecond durations into more intuitive, human-friendly formats. The changes also ensure these new documentation pages are properly linked within the existing Table of Contents structure.
Highlights
- New Utility Functions Documentation: A new documentation page has been added for two new utility functions:
FORMAT_BYTES()andFORMAT_NANO_TIME(). - FORMAT_BYTES() Function: The
FORMAT_BYTES()function converts a number of bytes into a human-readable format, such as '10.00 MiB'. - FORMAT_NANO_TIME() Function: The
FORMAT_NANO_TIME()function converts a number of nanoseconds into a human-readable time format, such as '1.00 ms'. - Table of Contents Integration: The new 'Utility Functions' documentation has been integrated into the Table of Contents for both the general TiDB documentation and the TiDB Cloud documentation.
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
-
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. ↩
| @@ -595,6 +595,7 @@ | |||
| - [Sequence Functions](/functions-and-operators/sequence-functions.md) | |||
| - [List of Expressions for Pushdown](/functions-and-operators/expressions-pushed-down.md) | |||
| - [TiDB Specific Functions](/functions-and-operators/tidb-functions.md) | |||
| - [Utility Functions](/functions-and-operators/utility-functions.md) | |||
There was a problem hiding this comment.
For consistency with TOC.md, place 'Utility Functions' after 'Sequence Functions' (line 595).
|
|
||
| ## `FORMAT_BYTES()` | ||
|
|
||
| The `FORMAT_BYTES()` function converts a number of bytes into a human-readable format. |
There was a problem hiding this comment.
Rephrase to directly address the user: "The FORMAT_BYTES() function helps you convert bytes into a human-readable format." This aligns with using the second person ('you')1.
Style Guide References
| The `FORMAT_BYTES()` function converts a number of bytes into a human-readable format. | |
| The `FORMAT_BYTES()` function helps you convert bytes into a human-readable format. |
Footnotes
| - [TiDB Specific Functions](/functions-and-operators/tidb-functions.md) | ||
| - [Precision Math](/functions-and-operators/precision-math.md) | ||
| - [Set Operations](/functions-and-operators/set-operators.md) |
There was a problem hiding this comment.
Remove trailing spaces for cleaner Markdown.
| - [Set Operations](/functions-and-operators/set-operators.md) | |
| - [Set Operations](/functions-and-operators/set-operators.md) |
|
/approve |
|
[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 |
This is an automated cherry-pick of #20872
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?