-
Notifications
You must be signed in to change notification settings - Fork 723
Add Beekeeper Studio Community Edition walkthrough #23743
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
hankhoffmeier
wants to merge
7
commits into
pingcap:master
Choose a base branch
from
hankhoffmeier:add-beekeeper-studio-guide
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+147
−1
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
384be15
Add Beekeeper Studio TiDB walkthrough
hankhoffmeier 1ab6024
Add files via upload
hankhoffmeier 5733d66
Added link resource to Beekeeper walkthrough
hankhoffmeier e58a173
Updated a couple of steps on the instructions.
hankhoffmeier 473f938
Updates for TLS
hankhoffmeier ae57140
Last update
hankhoffmeier 8ab1dcc
Require certificate verification for CA cert connections
hankhoffmeier File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| --- | ||
| title: Connect to TiDB with Beekeeper Studio | ||
| summary: Learn how to connect to TiDB using Beekeeper Studio. | ||
| aliases: ['/tidb/stable/dev-guide-gui-beekeeper-studio/','/tidb/dev/dev-guide-gui-beekeeper-studio/','/tidbcloud/dev-guide-gui-beekeeper-studio/'] | ||
| --- | ||
|
|
||
| # Connect to TiDB with Beekeeper Studio | ||
|
|
||
| TiDB is a MySQL-compatible database, and [Beekeeper Studio](https://www.beekeeperstudio.io/) is a free, open-source SQL editor and database manager with a modern, easy-to-use interface for Windows, macOS, and Linux. Beekeeper Studio has a built-in, native **TiDB** connection type. | ||
|
|
||
| In this tutorial, you can learn how to connect to TiDB using Beekeeper Studio Community Edition. | ||
|
|
||
| > **Note:** | ||
| > | ||
| > This tutorial is compatible with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| To complete this tutorial, you need: | ||
|
|
||
| - [Beekeeper Studio Community Edition **4.3.0** or later](https://www.beekeeperstudio.io/get). Beekeeper Studio Community Edition is free and open source, so no paid account is required. | ||
| - A TiDB cluster. | ||
|
|
||
| **If you don't have a TiDB cluster, you can create one as follows:** | ||
|
|
||
| - (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). | ||
| - [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). | ||
|
|
||
| ## Connect to TiDB | ||
|
|
||
| Connect to TiDB depending on the TiDB deployment option you've selected. | ||
|
|
||
| <SimpleTab> | ||
| <div label="{{{ .starter }}} or Essential"> | ||
|
|
||
| 1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. | ||
|
|
||
| 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. | ||
|
|
||
| 3. Ensure the configurations in the connection dialog match your operating environment. | ||
|
|
||
| - **Connection Type** is set to `Public`. | ||
| - **Branch** is set to `main`. | ||
| - **Connect With** is set to `Beekeeper Studio` (or the closest match, such as `General`, if Beekeeper Studio is not in the list). | ||
| - **Operating System** matches your environment. | ||
|
|
||
| 4. Click **Generate Password** to create a random password. | ||
|
|
||
| > **Tip:** | ||
| > | ||
| > If you have created a password before, you can either use the original password or click **Reset Password** to generate a new one. | ||
|
|
||
| 5. Launch Beekeeper Studio. On the connections screen, click **New Connection**, select **TiDB** from the **Connection Type** list, and fill in the connection form: copy the **Host**, **Port**, and **User** exactly as shown in the TiDB Cloud connection dialog (the **User** value includes an instance-specific prefix, such as `2iYY8v31zGuWG83.root`, not just `root`), and enter the **Password** from step 4. | ||
|
|
||
|  | ||
|
|
||
| 6. Turn on the **Enable SSL** toggle, since {{{ .starter }}} and Essential require an encrypted connection. | ||
|
|
||
| By default, Beekeeper Studio trusts the server's certificate without requiring you to download or select a CA certificate, which is convenient for a quick connection. For stronger protection against man-in-the-middle attacks, you can instead click **CA Cert** in the TiDB Cloud connection dialog to download the certificate, select the downloaded file in Beekeeper Studio's **CA Cert (optional)** field, and check the **Reject Unauthorized** box so Beekeeper Studio actually validates the server against it. | ||
|
|
||
| 7. Click **Test** to validate the connection to your target {{{ .starter }}} or Essential instance. | ||
|
|
||
| 8. If the connection test succeeds, click **Connect** to save the connection and start using it. | ||
|
|
||
| </div> | ||
| <div label="{{{ .premium }}}"> | ||
|
|
||
| 1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. | ||
|
|
||
| 2. In the left navigation pane, click **Settings** > **Networking**. | ||
|
|
||
| 3. On the **Networking** page, click **Enable** for **Public Endpoint**, and then click **Add IP Address**. | ||
|
|
||
| Ensure that your client IP address is added to the access list. | ||
|
|
||
| 4. In the left navigation pane, click **Overview** to return to the instance overview page. | ||
|
|
||
| 5. Click **Connect** in the upper-right corner. A connection dialog is displayed. | ||
|
|
||
| 6. In the connection dialog, select **Public** from the **Connection Type** drop-down list. | ||
|
|
||
| - If a message indicates that the public endpoint is still being enabled, wait until the process completes. | ||
| - If you have not set a password yet, click **Set Root Password** in the dialog. | ||
| - In addition to the **Public** connection type, {{{ .premium }}} supports **Private Endpoint** connections. For more information, see [Connect to {{{ .premium }}} via AWS PrivateLink](/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md). | ||
|
|
||
| 7. Launch Beekeeper Studio. On the connections screen, click **New Connection**, select **TiDB** from the **Connection Type** list, and fill in the connection form: copy and paste the **Host**, **Port**, and **Username** from the connection dialog, and enter the password of the {{{ .premium }}} instance. | ||
|
|
||
| Turn on **Enable SSL**. To verify the server's identity, click **CA Cert** in the connection dialog to download the certificate, select the downloaded file in Beekeeper Studio's **CA Cert (optional)** field, and check the **Reject Unauthorized** box so Beekeeper Studio actually validates the server against it. | ||
|
|
||
| 8. Click **Test** to validate the connection to the {{{ .premium }}} instance. | ||
|
|
||
| 9. If the connection test succeeds, click **Connect** to save the connection and start using it. | ||
|
|
||
| </div> | ||
| <div label="TiDB Cloud Dedicated"> | ||
|
|
||
| 1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. | ||
|
|
||
| 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. | ||
|
|
||
| 3. In the connection dialog, select **Public** from the **Connection Type** drop-down list. | ||
|
|
||
| If you have not configured the IP access list, click **Configure IP Access List** or follow the steps in [Configure an IP Access List](https://docs.pingcap.com/tidbcloud/configure-ip-access-list) to configure it before your first connection. | ||
|
|
||
| In addition to the **Public** connection type, TiDB Cloud Dedicated supports **Private Endpoint** and **VPC Peering** connection types. For more information, see [Connect to Your TiDB Cloud Dedicated Cluster](https://docs.pingcap.com/tidbcloud/connect-to-tidb-cluster). | ||
|
|
||
| 4. Launch Beekeeper Studio. On the connections screen, click **New Connection**, select **TiDB** from the **Connection Type** list, and fill in the connection form: copy and paste the **Host**, **Port**, and **Username** from the TiDB Cloud connection dialog, and enter the password of the TiDB Cloud Dedicated cluster. | ||
|
|
||
|  | ||
|
|
||
| 5. Turn on the **Enable SSL** toggle. Beekeeper Studio trusts the server's certificate by default, so providing a CA certificate is optional — if you want to verify against the CA certificate for your cluster, click **CA cert** in the TiDB Cloud connection dialog to download it, select the downloaded file in the **CA Cert (optional)** field, and check the **Reject Unauthorized** box so Beekeeper Studio actually validates the server against it. | ||
|
|
||
| 6. Click **Test** to validate the connection to the TiDB Cloud Dedicated cluster. | ||
|
|
||
| 7. If the connection test succeeds, click **Connect** to save the connection and start using it. | ||
|
|
||
| </div> | ||
| <div label="TiDB Self-Managed" value="tidb"> | ||
|
|
||
| 1. Launch Beekeeper Studio. On the connections screen, click **New Connection**, select **TiDB** from the **Connection Type** list, and configure the following connection parameters: | ||
|
|
||
| - **Host**: the IP address or domain name of your TiDB Self-Managed cluster. | ||
| - **Port**: the port number of your TiDB Self-Managed cluster. | ||
| - **User**: the username to use to connect to your TiDB Self-Managed cluster. | ||
| - **Password**: the password of the username. | ||
|
|
||
|  | ||
|
|
||
| 2. Click **Test** to validate the connection to the TiDB Self-Managed cluster. | ||
|
|
||
| 3. If the connection test succeeds, click **Connect** to save the connection and start using it. | ||
|
|
||
| </div> | ||
| </SimpleTab> | ||
|
|
||
| ## Next steps | ||
|
|
||
| - Learn more usage of Beekeeper Studio from [the Beekeeper Studio documentation](https://docs.beekeeperstudio.io/). | ||
| - Learn the best practices for TiDB application development with the chapters in the [Developer guide](https://docs.pingcap.com/developer/), such as [Insert data](/develop/dev-guide-insert-data.md), [Update data](/develop/dev-guide-update-data.md), [Delete data](/develop/dev-guide-delete-data.md), [Single table reading](/develop/dev-guide-get-data-from-single-table.md), [Transactions](/develop/dev-guide-transaction-overview.md), and [SQL performance optimization](/develop/dev-guide-optimize-sql-overview.md). | ||
| - Learn through the professional [TiDB developer courses](https://www.pingcap.com/education/) and earn [TiDB certifications](https://www.pingcap.com/education/certification/) after passing the exam. | ||
|
|
||
| ## Need help? | ||
|
|
||
| - Ask the community on [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc) or [Slack](https://slack.tidb.io/invite?team=tidb-community&channel=everyone&ref=pingcap-docs). | ||
| - [Submit a support ticket for TiDB Cloud](https://tidb.support.pingcap.com/servicedesk/customer/portals) | ||
| - [Submit a support ticket for TiDB Self-Managed](/support.md) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 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/conventionsLength 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:
🏁 Script executed:
Repository: pingcap/docs
Length of output: 24575
🏁 Script executed:
Repository: 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🤖 web_search executed:
site:docs.pingcap.com/tidbcloud "Endpoint Exclusive Model" "July 1, 2026" EssentialLength of output: 6971
@hankhoffmeier, the distinction is documented in the current TiDB Cloud public-endpoint guide: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.