@xata.io/kysely

A Kysely dialect for Xata, using the Xata serverless driver for TypeScript.

Installation

You should install both kysely and @xata.io/kysely with @xata.io/client. You can install them with your favorite package manager:

1# with bun
2bun install kysely @xata.io/kysely @xata.io/client
3
4# with pnpm
5pnpm add kysely @xata.io/kysely @xata.io/client
6
7# with yarn
8yarn add kysely @xata.io/kysely @xata.io/client
9
10# with npm
11npm install kysely @xata.io/kysely @xata.io/client

Usage

You can pass a new instance of XataDialect as the dialect option when creating a new Kysely instance:

1import { Kysely } from 'kysely';
2import { XataDialect, Model } from '@xata.io/kysely';
3import { DatabaseSchema, getXataClient } from './xata.ts';
4
5const xata = getXataClient();
6
7const db = new Kysely<Model<DatabaseSchema>>({
8  dialect: new XataDialect({ xata })
9});
10
11const drivers = await db.selectFrom('users').select(['name', 'email']).execute();

XataDialect accepts your Xata client instance as its only option. You can find more information about creating a Xata client instance in our getting started guide.