https://github.com/kysely-org/kysely-supabase

A toolkit (type translators for now) that allows using your existing Supabase setup with Kysely.
https://github.com/kysely-org/kysely-supabase

Last synced: 7 days ago
JSON representation

A toolkit (type translators for now) that allows using your existing Supabase setup with Kysely.

• Host: GitHub
• URL: https://github.com/kysely-org/kysely-supabase
• Owner: kysely-org
• License: mit
• Created: 2024-04-05T16:46:52.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-12-25T19:45:29.000Z (14 days ago)
• Last Synced: 2024-12-26T11:39:07.777Z (13 days ago)
• Language: TypeScript
• Homepage:
• Size: 970 KB
• Stars: 36
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-kysely - link - supabase?style=flat-square) <br/> <br/> | (Adapters)
• awesome-opensource-israel - kysely-supabase - A toolkit (type translators for now) that allows using your existing Supabase setup with Kysely.    (Projects by main language / typescript)

README

        
# kysely-supabase

Supabase is a combination of open-source tools. They're building the features of Firebase using enterprise-grade, open-source products. If the tools and communities exist, with an MIT, Apache 2, or equivalent open license, they will use and support that tool. If the tool doesn't exist, they build and open-source it themselves. Supabase is not a 1-to-1 mapping of Firebase. Their aim is to give developers a Firebase-like developer experience using open-source tools.

As of Apr 6, 2024, `@supabase/supabase-js` (the client library) has 292,860 weekly downloads on npm, while `supabase` (the CLI) has 80,273 weekly downloads on npm. It is a popular all-in-one development platform for Node.js and TypeScript.

Their CLI supports TypeScript type generation from your Supabase-managed PostgreSQL database, and their client library provides a nice, albeit restrictive, auto-completion friendly, and type-safe developer experience. For anything beyond what the client library's API offers, you're left with writing raw SQL and using PostgreSQL drivers like `pg` or `postgres`, or some abstraction where you codegen or define schema/types again.

Kysely (pronounced “Key-Seh-Lee”) is a type-safe and autocompletion-friendly TypeScript SQL query builder. Inspired by Knex. Mainly developed for Node.js but also runs on Deno and in the browser.

`kysely-supabase` is a toolkit (type translators for now) that allows using your existing Supabase setup with Kysely.

## Installation

```sh

npm i kysely @supabase/supabase-js

npm i -D kysely-supabase supabase

```

For PostgreSQL:

```sh

npm i pg

```

or

```sh

npm i kysely-postgres-js postgres

```

## Usage

### Types

Translate your Supabase-generated `Database` type to Kysely's `Database` interface via the `KyselifyDatabase` helper type.

`src/types/database.ts`:

```ts

import type {Database as SupabaseDatabase} from 'path/to/supabase/generated/types/file'

import type {KyselifyDatabase} from 'kysely-supabase'

export type Database = KyselifyDatabase

```

### Kysely Instance

Create a Kysely instance. Pass to it your `Database` type.

`src/kysely.ts`:

```ts

import {Kysely, PostgresDialect} from 'kysely'

import {Pool} from 'pg'

import type {Database} from './types/database'

export const kysely = new Kysely({

  dialect: new PostgresDialect({

    pool: new Pool({

      connectionString: process.env.DATABASE_URL,

    }),

  }),

})

```

or when using `postgres` instead of `pg` as the underlying driver:

```ts

import {Kysely} from 'kysely'

import {PostgresJSDialect} from 'kysely-postgres-js'

import postgres from 'postgres'

import type {Database} from './types/database'

export const kysely = new Kysely({

  dialect: new PostgresJSDialect({

    postgres: postgres(process.env.DATABASE_URL),

  }),

})

```

## Acknowledgements

`KyselifyDatabase` helper type was inspired by [Gilbert](https://github.com/gilbert)'s [issue](https://github.com/kysely-org/kysely/issues/461).