PlanetScale

Ardent works with PlanetScale Postgres. This page covers only what’s specific to PlanetScale — the full walkthrough is the Quickstart.

Using Claude Code or Cursor? It can do the checks for you

With the ardent-cli skill installed, a short ask is enough — the skill fetches this page and runs the checks:

Check if my PlanetScale Postgres database is ready to connect to Ardent.
My connection string: [paste here]

Without the skill, paste the full directions:

Check if my PlanetScale Postgres database is ready to connect to Ardent.
My connection string: [paste here]

Use Ardent preflight first:
ardent connector preflight postgresql '<connection-string>'

Verify:
1. The host is reachable and credentials work.
2. Logical replication is enabled in the PlanetScale dashboard.
3. The URL points to the writable primary: SELECT pg_is_in_recovery(); must return false.
4. The user has replication privileges.
5. Tables selected for replication have a primary key, valid unique NOT NULL index, or REPLICA IDENTITY FULL.

After preflight passes, run:
ardent connector create postgresql '<connection-string>'

Two things matter here:

Enable logical replication

In your PlanetScale dashboard, go to Settings > Integrations and enable Logical Replication. This is what lets Ardent replicate your data for branching.

Copy the connection string

Go to Connect > Connect with: Postgres and copy the connection string. It looks like:

postgresql://user:[YOUR-PASSWORD]@aws.connect.psdb.cloud/mydb?sslmode=require

Wrap it in single quotes in your shell — the ?sslmode=… part must not be interpreted by the shell.

From here, continue with the Quickstart: run preflight, fix anything it reports, then create the connector.

Getting started

Examples

Connectors

Concepts

Help