Database guides

PlanetScale

Updated 2026-08-11 · 2 min read

Managed Vitess with a MySQL-compatible endpoint. AddisDB connects with its MySQL driver; branch-and-deploy-request workflow replaces direct schema edits.

PlanetScale is a managed Vitess platform that presents a MySQL-compatible endpoint. AddisDB connects with its MySQL driver over TLS on port 3306. What you are talking to is vtgate, Vitess’s query router, rather than a MySQL server directly.

Who it is for

PlanetScale suits teams who expect to outgrow one MySQL server and want horizontal sharding without building it, and who like schema changes going through a branch and a deploy request rather than an ALTER run by hand.

That workflow is the thing to understand before you connect. On a production branch, schema changes are meant to arrive through a deploy request, and direct DDL is restricted. AddisDB will happily generate an ALTER for you, but the platform is entitled to refuse it — and the refusal comes from PlanetScale, not from the app. Point AddisDB at a development branch when you are changing schema.

Set up the branch

  1. In the PlanetScale dashboard open your database and pick the branch you want.
  2. Choose Connect, and select a generic MySQL client rather than a framework — you want host, username and password rather than a DSN string.
  3. Copy the host (it looks like aws.connect.psdb.cloud), the generated username and the password. The password is shown once.
  4. Note the database name; it is the name of the database, not of the branch.

Connect from AddisDB

  1. New Connection → PlanetScale. Port prefills to 3306.
  2. Enter the host, the generated username and password, and the database name.
  3. Set SSL mode to require. On Linux you may also need to point the CA certificate field at your system CA bundle, commonly /etc/ssl/certs/ca-certificates.crt.
  4. Test, then Save.

What AddisDB gives you

Queries, the schema tree, in-grid editing, mock data and the structured create and alter table builders all work — subject to what the branch you are on permits.

Query plans go through MySQL’s EXPLAIN FORMAT=JSON. Note that what you get back is vtgate’s plan for routing and combining the query, which is the honest answer for a sharded database but is not the same shape as a single-server MySQL plan.

The Live Monitor reads the process list that vtgate exposes, so you see the connections it is serving. Statement statistics are not available — PlanetScale does not expose performance_schema, so the profile view will tell you so rather than showing an empty table.