Add Beekeeper Studio Community Edition walkthrough - #23743
Conversation
ti-chi-bot
Bot
added
contribution
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Hi @hankhoffmeier. Thanks for your PR. I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions 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. |
|
Welcome @hankhoffmeier! |
ti-chi-bot
Bot
added
missing-translation-status
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Team Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review. 📝 WalkthroughWalkthroughAdded a developer guide for connecting Beekeeper Studio Community Edition to TiDB Cloud and TiDB Self-Managed deployments. The third-party support table now links to the new tutorial. ChangesBeekeeper Studio documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: 🟡 Moderate · up to The new connection guide may provide incomplete instructions for TiDB Cloud Essential users with different endpoint models, potentially preventing successful Beekeeper Studio connections. This should be resolved before merge. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Team
Run ID: 75dbd85c-2a74-46c0-9153-525836161103
⛔ Files ignored due to path filters (2)
media/develop/beekeeper-studio-connection-settings-self-hosted.pngis excluded by!**/*.pngmedia/develop/beekeeper-studio-connection-settings.pngis excluded by!**/*.png
📒 Files selected for processing (2)
develop/dev-guide-gui-beekeeper-studio.mddevelop/dev-guide-third-party-support.md
Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.
| Connect to TiDB depending on the TiDB deployment option you've selected. | ||
|
|
||
| <SimpleTab> | ||
| <div label="{{{ .starter }}} or Essential"> |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | 🏗️ Heavy lift
🔎 Supported by static analysis
🏁 Script executed:
sed -n '1,75p' develop/dev-guide-gui-beekeeper-studio.mdRepository: pingcap/docs
Length of output: 3963
🤖 get_repo_knowledge executed:
get_repo_knowledge pingcap/docs /tmp/coderabbit-repo-knowledge/pingcap-docs-9c73f70c/learnings /tmp/coderabbit-repo-knowledge/pingcap-docs-9c73f70c/conventions
Length of output: 4069
🌐 Web query:
site:docs.pingcap.com/tidbcloud "exclusive endpoint" Essential July 1 2026 shared endpoint
💡 Result:
In TiDB Cloud, the distinction between the endpoint shared model and the endpoint exclusive model for Essential instances is based on the creation date of the instance, with July 1, 2026, serving as the cutoff date [1][2][3]. Endpoint Shared Model: - Applies to all TiDB Cloud Starter instances and TiDB Cloud Essential instances created before July 1, 2026 [1][4][3]. - In this model, a single private or public endpoint can be shared by multiple TiDB Cloud Starter or Essential instances located within the same region and VPC [1][4][3]. - When connecting to instances using this model, users are required to include a mandatory account prefix in their connection string [1][2][3]. Endpoint Exclusive Model: - Applies to TiDB Cloud Essential instances created on or after July 1, 2026 [1][2][3]. - In this model, each Essential instance is assigned its own standalone private or public endpoint [1][4][3]. - A primary benefit of this model is that it eliminates the need to include an account prefix when connecting to the instance [1][2][3]. - Users must repeat the network setup steps for each individual Essential instance they wish to connect to in this mode [1][2][4]. Please note that the endpoint exclusive model is currently only available in certain AWS regions [1][2][4]. If it is not supported for a specific instance, the shared model is used instead [1][2][4].
Citations:
- 1: https://docs.pingcap.com/tidbcloud/set-up-private-endpoint-connections-serverless/
- 2: https://docs.pingcap.com/tidbcloud/set-up-private-endpoint-connections-serverless.md
- 3: https://docs.pingcap.com/tidbcloud/serverless-private-link-connection/
- 4: https://docs.pingcap.com/tidbcloud/connect-via-standard-connection-serverless/
🏁 Script executed:
rg -n -i "exclusive endpoint|shared endpoint|July 1, 2026|Essential.*endpoint|endpoint.*Essential" --glob '*.md' .Repository: pingcap/docs
Length of output: 24575
🏁 Script executed:
sed -n '1,70p' tidb-cloud/connect-via-standard-connection-serverless.md
printf '\n--- related username/account-prefix references ---\n'
rg -n -i "account prefix|username|user name|user.*prefix|exclusive model|shared model|July 1, 2026" tidb-cloud/connect-via-standard-connection-serverless.md tidb-cloud/set-up-private-endpoint-connections-serverless.md develop/dev-guide-gui-beekeeper-studio.mdRepository: pingcap/docs
Length of output: 6240
Separate the TiDB Cloud Essential endpoint models.
This tab combines Starter and Essential instances under one public-endpoint procedure. Essential instances can use shared or exclusive endpoints, which have different connection steps and username requirements. State which endpoint model this procedure supports, or provide separate instructions for each model. ( )
There was a problem hiding this comment.
Thanks for the catch — I don't see a shared vs. exclusive endpoint distinction documented anywhere in the current TiDB Cloud docs for Starter/Essential, so I don't want to add procedural steps I haven't verified against the real console. Happy to revisit if you can point me to where that's documented.
There was a problem hiding this comment.
🧩 Analysis chain
🤖 web_search executed:
site:docs.pingcap.com/tidbcloud "Endpoint Exclusive Model" "July 1, 2026" Essential
Length of output: 6971
@hankhoffmeier, the distinction is documented in the current TiDB Cloud public-endpoint guide:
- Choose an endpoint model
- Connect via a public endpoint (endpoint shared model)
- Connect via a public endpoint (endpoint exclusive model)
The guide states that Starter instances and Essential instances created before July 1, 2026 use the shared model. Essential instances created on or after that date use the exclusive model where available. The shared model requires the account prefix in the user name. The exclusive model does not.
You are interacting with an AI system.
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Team
Run ID: fcd005e0-178e-4e66-8589-a31295f09e33
📒 Files selected for processing (1)
develop/dev-guide-gui-beekeeper-studio.md
Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.
|
updated in the latest commit: Require certificate verification for CA cert connections |
1 participant
First-time contributors' checklist
What is changed, added, or deleted? (Required)
Added a "Connect to TiDB with Beekeeper Studio" tutorial page and linked it from the GUI tools table, replacing the "N/A" Tutorial cell for Beekeeper Studio.Closes #18009
Disclosure: I'm an operations contractor for Beekeeper Studio. I tested this walkthrough end-to-end against a TiDB Cloud Starter cluster and a local tiup playground cluster before writing it up.
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)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit