Skip to content

develop: add documents for TiDB Cloud Premium#22533

Merged
ti-chi-bot[bot] merged 5 commits intofeature/preview-premiumfrom
feat-develop-for-premium
Apr 23, 2026
Merged

develop: add documents for TiDB Cloud Premium#22533
ti-chi-bot[bot] merged 5 commits intofeature/preview-premiumfrom
feat-develop-for-premium

Conversation

@Icemap
Copy link
Copy Markdown
Member

@Icemap Icemap commented Mar 5, 2026

First-time contributors' checklist

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

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

@ti-chi-bot ti-chi-bot Bot added area/develop This PR relates to the area of TiDB App development. missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Mar 5, 2026
@Icemap
Copy link
Copy Markdown
Member Author

Icemap commented Mar 5, 2026

/cc @Oreoxmt

@ti-chi-bot ti-chi-bot Bot requested a review from Oreoxmt March 5, 2026 08:34
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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 enhances the documentation for TiDB Cloud Premium by integrating detailed connection instructions into existing guides for various GUI tools and sample applications. The changes aim to provide a seamless experience for users looking to connect their development environments and applications to TiDB Cloud Premium instances, covering setup steps from enabling public endpoints to configuring specific client-side connection parameters, including SSL settings where applicable.

Highlights

  • Expanded TiDB Cloud Premium Documentation: Comprehensive connection guides have been added for TiDB Cloud Premium across numerous GUI tools and sample applications, ensuring users can easily integrate their workflows.
  • Updated Compatibility Notes: All affected documentation files now explicitly list TiDB Cloud Premium as a compatible service, improving clarity for users.
  • Detailed Connection Instructions: New sections provide step-by-step instructions for enabling public endpoints, configuring IP access lists, and setting up environment variables or connection parameters specific to TiDB Cloud Premium.
  • SSL Configuration Updates: Several sample application guides now include explicit TIDB_ENABLE_SSL environment variables and conditional SSL configuration in the connection code.

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

Changelog
  • develop/dev-guide-gui-datagrip.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium users.
  • develop/dev-guide-gui-dbeaver.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium users.
  • develop/dev-guide-gui-mysql-workbench.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium users.
  • develop/dev-guide-gui-navicat.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium users.
  • develop/dev-guide-gui-vscode-sqltools.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium users.
  • develop/dev-guide-sample-application-aws-lambda.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium.
    • Modified env.json to include TIDB_ENABLE_SSL and updated SSL configuration logic.
  • develop/dev-guide-sample-application-golang-gorm.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including .env setup.
  • develop/dev-guide-sample-application-golang-sql-driver.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including .env setup.
  • develop/dev-guide-sample-application-java-hibernate.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including env.sh setup.
  • develop/dev-guide-sample-application-java-jdbc.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including env.sh setup.
  • develop/dev-guide-sample-application-java-mybatis.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including env.sh setup.
  • develop/dev-guide-sample-application-java-spring-boot.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including env.sh setup.
  • develop/dev-guide-sample-application-nextjs.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium.
    • Modified .env to include TIDB_ENABLE_SSL and updated SSL configuration logic.
  • develop/dev-guide-sample-application-nodejs-mysql2.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including .env setup.
  • develop/dev-guide-sample-application-nodejs-mysqljs.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including .env setup.
  • develop/dev-guide-sample-application-nodejs-prisma.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including .env and schema.prisma setup.
  • develop/dev-guide-sample-application-nodejs-sequelize.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including .env setup.
  • develop/dev-guide-sample-application-nodejs-typeorm.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including .env setup.
  • develop/dev-guide-sample-application-python-django.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including .env setup.
  • develop/dev-guide-sample-application-python-mysql-connector.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including .env setup.
  • develop/dev-guide-sample-application-python-mysqlclient.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including .env setup.
  • develop/dev-guide-sample-application-python-peewee.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including .env setup.
  • develop/dev-guide-sample-application-python-pymysql.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including .env setup.
  • develop/dev-guide-sample-application-python-sqlalchemy.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including .env setup.
  • develop/dev-guide-sample-application-ruby-mysql2.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including .env setup.
  • develop/dev-guide-sample-application-ruby-rails.md
    • Updated compatibility note to include TiDB Cloud Premium.
    • Added detailed connection instructions for TiDB Cloud Premium, including .env setup.
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.

Copy link
Copy Markdown
Contributor

@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 documentation for the new TiDB Cloud Premium tier across various developer guides. The changes are generally well-executed and consistent. I've provided a few suggestions to enhance consistency in formatting and wording, ensuring the new content aligns perfectly with the existing documentation and style guidelines.

Note: Security Review has been skipped due to the limited scope of the PR.

Comment thread develop/dev-guide-gui-vscode-sqltools.md

4. Click **Overview** in the left panel to return to the overview page.

5. Click **Connect** in the upper right corner. A connection dialog is displayed. In the connection dialog, select `Public` from the **Connection Type** drop-down list.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

low

For consistency with other documentation files, upper right should be hyphenated.

Suggested change
5. Click **Connect** in the upper right corner. A connection dialog is displayed. In the connection dialog, select `Public` from the **Connection Type** drop-down list.
5. Click **Connect** in the upper-right corner. A connection dialog is displayed. In the connection dialog, select `Public` from the **Connection Type** drop-down list.
References
  1. The style guide (line 20) recommends correcting spelling and punctuation mistakes. 'upper-right' is the consistent and correct form used across the documentation. (link)

@Oreoxmt Oreoxmt self-assigned this Mar 5, 2026
@Oreoxmt Oreoxmt added the translation/doing This PR's assignee is translating this PR. label Mar 5, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Mar 5, 2026
@Oreoxmt Oreoxmt added missing-translation-status This PR does not have translation status info. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. needs-cherry-pick-master Should cherry pick this PR to master branch. labels Mar 5, 2026
@Oreoxmt
Copy link
Copy Markdown
Collaborator

Oreoxmt commented Mar 6, 2026

/cc @Mini256

@ti-chi-bot ti-chi-bot Bot requested a review from Mini256 March 6, 2026 02:46
@Oreoxmt Oreoxmt changed the base branch from release-8.5 to feature/preview-one-console March 6, 2026 03:42
@Oreoxmt Oreoxmt removed the missing-translation-status This PR does not have translation status info. label Mar 24, 2026
@Oreoxmt Oreoxmt force-pushed the feat-develop-for-premium branch from 52a0891 to 733faeb Compare March 25, 2026 02:13
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Mar 25, 2026
Comment thread develop/dev-guide-gui-datagrip.md Outdated
Comment thread develop/dev-guide-gui-datagrip.md Outdated
Comment thread develop/dev-guide-gui-datagrip.md Outdated
Comment thread develop/dev-guide-gui-datagrip.md Outdated
@Oreoxmt Oreoxmt changed the title feat: develop document for tidb cloud premium develop: add documents for TiDB Cloud Premium Apr 7, 2026
@Oreoxmt Oreoxmt requested a review from qiancai April 7, 2026 02:43
@Oreoxmt Oreoxmt changed the base branch from feature/preview-one-console to feature/preview-premium April 15, 2026 03:08
@Oreoxmt Oreoxmt changed the base branch from feature/preview-premium to feature/preview-one-console April 15, 2026 03:10
@Oreoxmt Oreoxmt force-pushed the feat-develop-for-premium branch from 2fabbb4 to 1001899 Compare April 15, 2026 03:13
@Oreoxmt Oreoxmt changed the base branch from feature/preview-one-console to feature/preview-premium April 15, 2026 03:13
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Apr 15, 2026

@Oreoxmt: Your lgtm message is repeated, so it is ignored.

Details

In response to this:

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.

@ti-chi-bot ti-chi-bot Bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Apr 15, 2026
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Apr 15, 2026

[LGTM Timeline notifier]

Timeline:

  • 2026-03-25 02:19:27.461128135 +0000 UTC m=+321163.497198395: ☑️ agreed by Oreoxmt.
  • 2026-04-15 03:19:16.108852141 +0000 UTC m=+1531161.314212208: ☑️ agreed by qiancai.

Copy link
Copy Markdown
Member

@Mini256 Mini256 left a comment

Choose a reason for hiding this comment

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

LGTM

@Oreoxmt Oreoxmt added area/tidb-cloud This PR relates to the area of TiDB Cloud. for-cloud-release This PR is related to TiDB Cloud release. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels Apr 22, 2026
@Oreoxmt
Copy link
Copy Markdown
Collaborator

Oreoxmt commented Apr 22, 2026

/approve

@Oreoxmt
Copy link
Copy Markdown
Collaborator

Oreoxmt commented Apr 22, 2026

/unhold

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Apr 22, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Oreoxmt

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:

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 approved and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Apr 22, 2026
@ti-chi-bot ti-chi-bot Bot merged commit 2a3c1a0 into feature/preview-premium Apr 23, 2026
5 checks passed
@ti-chi-bot
Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch master: #22798.

@Oreoxmt Oreoxmt deleted the feat-develop-for-premium branch April 24, 2026 05:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/develop This PR relates to the area of TiDB App development. area/tidb-cloud This PR relates to the area of TiDB Cloud. for-cloud-release This PR is related to TiDB Cloud release. lgtm needs-cherry-pick-master Should cherry pick this PR to master branch. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants