Connecting to TiDB Cloud

  1. Open the connections page in preferences, see managing connections for more information.
  2. Click the Add new connection button at the top of the connections page.
  3. Select MySQL from the list (TiDB uses the MySQL driver).

  1. Give a Connection name for your own internal reference.
  2. For Hostname, enter the hostname of your database server.
  3. For Port, use the default 4000, or enter the port used by your server.
  4. For Database, enter the name of your database.
  5. For Username and Password, enter the username and password from PlanetScale. These are optional.
  6. Toggle connection type for direct or cloud.
  7. Share the connection with your team.
  8. Enable SSL. TiDB requires SSL, but you can leave the certificates blank to use the default Debian OS certificate.
    Note: TiDB is an open-source MySQL-Compatible HTAP distributed database that has 3 deployments:
    1. TiDB Self-Hosted: Self-managed TiDB clusters run on users' environments.
    2. TiDB Dedicated: It's a TiDB Cloud deployment following the traditional database vendors. It's fixed specs.
    3. TiDB Serverless: Another TiDB Cloud deployment. By name, it's serverless, charge by usage, scale infinitely.
      When connecting, TiDB Self-Hosted and TiDB Dedicated use a self-signed certificate and users should upload the Root Certificate to PopSQL to connect. TiDB Serverless uses Let's Encrypt CA so usually there is no need to upload the Root Certificate.
  9. (Optional) Configure SSH settings.
  10. Hit Connect and you're all set!

Happy querying! 🍭

Cookie settings