Skip to content

docs: clarify package is for MySQL, add note about Postgres setup #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SimeonGriggs wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify package is for MySQL, add note about Postgres setup #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
[![npm](https://img.shields.io/npm/v/kysely-planetscale.svg)](https://www.npmjs.com/package/kysely-planetscale)
![Powered by TypeScript](https://img.shields.io/badge/powered%20by-typescript-blue.svg)

A [Kysely](https://github.com/koskimas/kysely) dialect for [PlanetScale](https://planetscale.com/), using the [PlanetScale serverless driver for JavaScript](https://planetscale.com/blog/introducing-the-planetscale-serverless-driver-for-javascript).
A [Kysely](https://github.com/koskimas/kysely) dialect for [PlanetScale](https://planetscale.com/) **MySQL**, using the [PlanetScale serverless driver for JavaScript](https://planetscale.com/blog/introducing-the-planetscale-serverless-driver-for-javascript).

> **Using PlanetScale Postgres?** This package is specifically for PlanetScale's MySQL-compatible database (Vitess). If you're using PlanetScale Postgres, you don't need this package — use Kysely's built-in `PostgresDialect` with the standard `pg` driver instead. See the [PlanetScale Postgres with Kysely](https://planetscale.com/docs/postgres/tutorials/planetscale-postgres-kysely) documentation for setup instructions.

## Installation

Expand Down