PlanetScale

Connect to PlanetScale using the serverless HTTP driver. Works on edge runtimes where TCP connections are unavailable.

import { createEngine } from '@superapp/backend'
import { planetscaleProvider } from '@superapp/backend/databases/planetscale'

const engine = createEngine({
  providers: [planetscaleProvider],
  connections: {
    main: { type: 'planetscale', connectionString: process.env.PLANETSCALE_URL! },
  },
})

Install

npm install @planetscale/database

Connection URL Format

mysql://username:password@host/database?ssl={"rejectUnauthorized":true}

Get your connection string from the PlanetScale dashboard under Connect → Connect with → @planetscale/database.

Connection Options

Option	Type	Description
`connectionString`	`string`	PlanetScale connection URL
`host`	`string`	PlanetScale host (alternative to URL)
`username`	`string`	Database username
`password`	`string`	Database password

Install

Connection URL Format

Connection Options

On this page