UltiRequiem / planetscale

🪐 A simple client for connecting to PlanetScale

PlanetScale

A simple client for connecting to PlanetScale.

Setup

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_branch

If you plan to use dotenv, you could write a .env file like:

db=
tokenName=
org=
token=

Install

npm install planetscale # yarn add planetscale

Usage

import connect from "planetscale";
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.

Licence

Released under the MIT Licence.