PlanetScale
Reylo on PlanetScale's MySQL and Postgres databases
A PlanetScale MySQL database is MySQL, so everything on the MySQL page holds for it.
| Dialect | MySQL, served through Vitess; a PlanetScale Postgres database is Postgres |
| What the type check reads | A MySQL 8.0.38 or later server with your schema, such as a local one |
| Drivers | @planetscale/database 1.x, mysql2 and Drizzle |
| Schema | The migrations you deploy to PlanetScale, applied to that server too |
| Monitoring | Insights shows the .sql file each query came from |
View the schema behind the examples
create table users (
id int auto_increment primary key,
name varchar(100) not null,
email varchar(255)
);Drivers
@planetscale/database
Pass a connection from connect(), a Client, or the transaction that .transaction() hands its callback:
// @planetscale/database 1.x: a 2.0 client is a type error
import { } from "@planetscale/database";
import from "./get_user.sql";
const = ({ : .. });
const user = await .(, { : 1 });
await .(() => .(, { : 1 }));select id, name, email
from users
where id = :id- Version 2.0 isn't supported, since it can't bind parameters.
- The driver sends each query over HTTP, so it runs where there are no TCP sockets, as in Cloudflare Workers.
- It rounds a
FLOATto its shorter text,1.1, wheremysql2returns its exact value (Decimals).
mysql2
Pass a pool, or a connection taken from one, which can run a transaction:
import from "mysql2/promise";
import from "./get_user.sql";
const = .(..);
const = await .(, { : 1 });
const = await .();
await .();
await .(, { : 1 });
await .();
.();select id, name, email
from users
where id = :idPlanetScale's connection string for Node ends with an ssl setting, which mysql2 reads to check the server's certificate:
DATABASE_URL=mysql://…/app?ssl={"rejectUnauthorized":true}Drizzle
Pass a Drizzle database over a Client from @planetscale/database:
import { } from "@planetscale/database";
import { } from "drizzle-orm/planetscale-serverless";
import from "./get_user.sql";
const = (new ({ : .. }));
const = await .(, { : 1 });select id, name, email
from users
where id = :idLocal database
The type check reads a MySQL server with your schema. PlanetScale serves MySQL through Vitess, which the type check isn't tested on, so run MySQL 8.0.38 or later locally:
docker run -d -p 3306:3306 -e MYSQL_DATABASE=app \
-e MYSQL_ALLOW_EMPTY_PASSWORD=yes mysql:8.4Point direct_url at it:
# local mysql, migrations applied
direct_url: mysql://root@127.0.0.1:3306/app- Set it in
.reylo.yaml, so thatDATABASE_URLstays your app's PlanetScale connection string. Without it, the type check readsDATABASE_URL. - Your queries still run on PlanetScale, through the client you pass to
.run().
Schema
Apply each migration you deploy to PlanetScale to the local server too, with the same tool:
for file in migrations/*.sql; do
mysql -h 127.0.0.1 -u root app < "$file"
done- With Prisma or Drizzle Kit, run its migrate command against the local server (Schema).
- In CI, start MySQL as a service and apply the same migrations before the type check (Deployment / CI).
- A host that builds before it migrates, such as Vercel, needs a MySQL server of its own for the build (Deployment / CI).
Insights
Each query Reylo sends ends with a sqlcommenter comment that names its file, which PlanetScale's Insights reads as the query's file tag:
select id, name, email from users where id = ? /*file='queries%2Fget_user.sql'*/PlanetScale Postgres
A PlanetScale Postgres database is Postgres. Point direct_url at its direct connection on port 5432, not at PgBouncer on port 6432, whose transaction mode can fail to describe a query:
# pgbouncer, for your app
DATABASE_URL=postgres://…:6432/…
# the direct connection, for the type check
DIRECT_DATABASE_URL=postgres://…:5432/…direct_url: ${DIRECT_DATABASE_URL}Run your queries with any Postgres driver.