https://github.com/ultirequiem/planetscale

🪐 A simple client for connecting to PlanetScale
https://github.com/ultirequiem/planetscale

database db-driver javascript mysql node nodejs planetscale typescript

Last synced: 25 days ago
JSON representation

🪐 A simple client for connecting to PlanetScale

• Host: GitHub
• URL: https://github.com/ultirequiem/planetscale
• Owner: UltiRequiem
• License: mit
• Created: 2022-02-01T23:53:37.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-19T08:59:37.000Z (over 1 year ago)
• Last Synced: 2024-10-04T17:53:16.272Z (about 1 month ago)
• Topics: database, db-driver, javascript, mysql, node, nodejs, planetscale, typescript
• Language: TypeScript
• Homepage: https://ulti.js.org/planetscale
• Size: 116 KB
• Stars: 8
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# PlanetScale

A simple client for connecting to [PlanetScale](https://planetscale.com).

## Setup

You need to have installed [pscale](https://github.com/planetscale/cli).

```sh

$ 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](https://github.com/motdotla/dotenv), you could write

a `.env` file like:

```sh

db=

tokenName=

org=

token=

```

## Install

```sh

npm install planetscale # yarn add planetscale

```

## Usage

```js

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](https://github.com/mysqljs/mysql) to know all the API.

Check [examples/](./examples) for more.

## Licence

Released under the MIT Licence.