dev doc: update the example of paginate results (#21107)

[ti-chi-bot]

This is an automated cherry-pick of #21107

fix sql

First-time contributors' checklist

• I've signed Contributor License Agreement that's required for repo owners to accept my contribution.

What is changed, added or deleted? (Required)

fix sql

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:dev doc: update the example of paginate results docs-cn#20449
• Other reference 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

[gemini-code-assist]

Hello @ti-chi-bot, I'm Gemini Code Assist¹! 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 here, providing a summary of this pull request. This PR, authored by ti-chi-bot, appears to be an automated cherry-pick aimed at updating the developer documentation. Specifically, it modifies an example SQL query within the guide on paginating results. The primary goal seems to be fixing or improving the SQL syntax used in the example, likely to handle edge cases or make it more robust, as indicated by the description 'fix sql' and the changes in the query logic. The changes are applied to the master, v9.1, v8.5, and v8.1 documentation branches.

Highlights

• Documentation Update: The pull request updates the developer guide located at develop/dev-guide-paginate-results.md.
• SQL Example Correction: The example SQL query used for paginating and potentially deleting results within the documentation has been significantly modified to include more complex logic, possibly to address edge cases related to start and end keys.

Changelog

• develop/dev-guide-paginate-results.md
  • Modified the example SQL query for paginating/deleting results to include conditional logic based on start and end key values (starting around line 306).
  • Added a newline character at the end of the file (starting around line 330).

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. ↩

[gemini-code-assist]

Code Review

This pull request updates an SQL example in the pagination guide. The core change to the SQL query's structure is a good fix, addressing a potential bug in the previous example when paginating over composite keys where the first key component might be the same at the start and end of a page.

However, there's a critical issue where the example meant to demonstrate a DELETE operation incorrectly uses a SELECT statement. Additionally, an ORDER BY clause is present, which is generally not used with DELETE in this context and should be removed.

The minor change to add a newline at the end of the file is a good housekeeping fix.

I've referenced the following aspects of the Documentation Review Style Guide in this review:

• Line 5: Emphasizing ready-to-commit suggestions.
• Line 14: Focusing on clarity, simplicity, completeness, and readability of the documentation.
• Line 16: Ensuring technical accuracy of the examples provided.

The PR description is quite brief ("fix sql"). While this is an automated cherry-pick, providing a little more context about what specific SQL issue was fixed would be beneficial for future readers and maintainers, even if it's a link to the original detailed explanation.

Summary of Findings

• Incorrect SQL statement type: The documentation describes a DELETE operation, but the provided SQL example is a SELECT statement. This needs to be corrected to DELETE.
• Unnecessary ORDER BY in DELETE example: The SQL example for deleting records includes an ORDER BY clause, which is generally not applicable or needed for DELETE statements based on a WHERE clause and should be removed.
• SQL Query Structure: The updated SQL structure itself is a good improvement, as it correctly handles pagination over composite keys, especially when the first component of the key is the same for the start and end of a page. The previous version had a bug in this scenario.

Merge Readiness

The pull request addresses an important bug in the SQL pagination example. However, there's a critical issue where the example shows a SELECT statement instead of the intended DELETE statement. This, along with the removal of the unnecessary ORDER BY clause in the DELETE context, must be addressed before merging. I am unable to approve pull requests, but I recommend making these changes to ensure the documentation is accurate and helpful for users. Once these changes are made, the PR should be in good shape.

[ti-chi-bot]

@gemini-code-assist[bot]: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

Code Review

This pull request updates an SQL example in the pagination guide. The core change to the SQL query's structure is a good fix, addressing a potential bug in the previous example when paginating over composite keys where the first key component might be the same at the start and end of a page.

However, there's a critical issue where the example meant to demonstrate a DELETE operation incorrectly uses a SELECT statement. Additionally, an ORDER BY clause is present, which is generally not used with DELETE in this context and should be removed.

The minor change to add a newline at the end of the file is a good housekeeping fix.

I've referenced the following aspects of the Documentation Review Style Guide in this review:

• Line 5: Emphasizing ready-to-commit suggestions.
• Line 14: Focusing on clarity, simplicity, completeness, and readability of the documentation.
• Line 16: Ensuring technical accuracy of the examples provided.

The PR description is quite brief ("fix sql"). While this is an automated cherry-pick, providing a little more context about what specific SQL issue was fixed would be beneficial for future readers and maintainers, even if it's a link to the original detailed explanation.

Summary of Findings

• Incorrect SQL statement type: The documentation describes a DELETE operation, but the provided SQL example is a SELECT statement. This needs to be corrected to DELETE.
• Unnecessary ORDER BY in DELETE example: The SQL example for deleting records includes an ORDER BY clause, which is generally not applicable or needed for DELETE statements based on a WHERE clause and should be removed.
• SQL Query Structure: The updated SQL structure itself is a good improvement, as it correctly handles pagination over composite keys, especially when the first component of the key is the same for the start and end of a page. The previous version had a bug in this scenario.

Merge Readiness

The pull request addresses an important bug in the SQL pagination example. However, there's a critical issue where the example shows a SELECT statement instead of the intended DELETE statement. This, along with the removal of the unnecessary ORDER BY clause in the DELETE context, must be addressed before merging. I am unable to approve pull requests, but I recommend making these changes to ensure the documentation is accurate and helpful for users. Once these changes are made, the PR should be in good shape.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[hfxsd]

/approve

[ti-chi-bot]

[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

Details

Needs approval from an approver in each of these files:

• develop/OWNERS [hfxsd]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment