A simple client for connecting to PlanetScale
You need to have installed pscale.
$ pscale service-token create
NAME TOKEN
-------------- ------------------------------------------
tokenName token
$ pscale service-token add-access tokenName connect_production_branch --database test
DATABASE ACCESSES
---------- ---------------------------
test connect_production_branchIf you plan to use dotenv, you could
write a .env file like:
db=
tokenName=
org=
token=npm install planetscale # yarn add planetscaleimport connect from "../../dist/index.js";
import { env } from "node:process";
import "dotenv/config";
const { db, tokenName, org, token } = env;
const connection = await connect({ db, tokenName, org, token });
const [rows] = await connection.promise().query("SELECT * FROM Persons");
console.log(rows);
connection.end();The default export, connect, returns a
Connection,
it is basically a wrapper around mysql2.createConnection. Check the
docs to know all the API.
Check examples/ for more.
Released under the MIT Licence.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent