kysely-surrealdb
v0.7.4
Published
Kysely dialects, plugins and other goodies for SurrealDB
Downloads
763
Maintainers
Readme
kysely-surrealdb
Kysely dialects, plugins and other goodies for SurrealDB.
SurrealQL is based on SQL, so why not? :trollface:
Installation
NPM 7+
npm i kysely-surrealdb
NPM <7
npm i kysely-surrealdb kysely surrealdb.js
Yarn
yarn add kysely-surrealdb kysely surrealdb.js
PNPM
pnpm add kysely-surrealdb kysely surrealdb.js
surrealdb.js
is an optional peer dependency. It's only needed if you want to useSurrealDbWebSocketsDialect
. If you don't need it, you can removesurreal.js
from the install commands above.
Deno
This package uses/extends some Kysely types and classes, which are imported using its NPM package name -- not a relative file path or CDN url.
SurrealDbWebSocketsDialect
uses surrealdb.js
which is imported using its NPM package name -- not a relative file path or CDN url.
To fix that, add an import_map.json
file.
{
"imports": {
"kysely": "https://cdn.jsdelivr.net/npm/[email protected]/dist/esm/index.js",
"surrealdb.js": "https://deno.land/x/[email protected]" // optional - only if you're using `SurrealDbWebSocketsDialect`
}
}
Usage
HTTP Dialect
SurrealDB's HTTP endpoints allow executing SurrealQL queries in the browser and are a great fit for serverless functions and other auto-scaling compute services.
Node.js 16.8+
Older node versions are supported as well, just swap undici
with node-fetch
.
import {Kysely} from 'kysely'
import {SurrealDatabase, SurrealDbHttpDialect, type SurrealEdge} from 'kysely-surrealdb'
import {fetch} from 'undici'
interface Database {
person: {
first_name: string | null
last_name: string | null
age: number
}
own: SurrealEdge<{
time: {
adopted: string
} | null
}>
pet: {
name: string
owner_id: string | null
}
}
const db = new Kysely<SurrealDatabase<Database>>({
dialect: new SurrealDbHttpDialect({
database: '<database>',
fetch,
hostname: '<hostname>', // e.g. 'localhost:8000'
namespace: '<namespace>',
password: '<password>',
username: '<username>',
}),
})
WebSockets Dialect
import {Kysely} from 'kysely'
import {SurrealDatabase, SurrealDbWebSocketsDialect, type SurrealEdge} from 'kysely-surrealdb'
import Surreal from 'surrealdb.js'
interface Database {
person: {
first_name: string | null
last_name: string | null
age: number
}
own: SurrealEdge<{
time: {
adopted: string
} | null
}>
pet: {
name: string
owner_id: string | null
}
}
// with username and password
const db = new Kysely<SurrealDatabase<Database>>({
dialect: new SurrealDbWebSocketsDialect({
database: '<database>',
Driver: Surreal,
hostname: '<hostname>', // e.g. 'localhost:8000'
namespace: '<namespace>',
password: '<password>',
// scope: '<scope>', // optional
username: '<username>',
}),
})
// alternatively, with a token
const dbWithToken = new Kysely<SurrealDatabase<Database>>({
dialect: new SurrealDbWebSocketsDialect({
database: '<database>',
Driver: Surreal,
hostname: '<hostname>', // e.g. 'localhost:8000'
namespace: '<namespace>',
token: '<token>',
}),
})
SurrealKysely Query Builder
The awesomeness of Kysely, with some SurrealQL query builders patched in.
This example uses
SurrealDbHttpDialect
butSurrealDbWebSocketsDialect
works just as well.
import {SurrealDbHttpDialect, SurrealKysely, type SurrealEdge} from 'kysely-surrealdb'
import {fetch} from 'undici'
interface Database {
person: {
first_name: string | null
last_name: string | null
age: number
}
own: SurrealEdge<{
time: {
adopted: string
} | null
}>
pet: {
name: string
owner_id: string | null
}
}
const db = new SurrealKysely<Database>({
dialect: new SurrealDbHttpDialect({
database: '<database>',
fetch,
hostname: '<hostname>',
namespace: '<namespace>',
password: '<password>',
username: '<username>',
}),
})
await db
.create('person:100')
.set({
first_name: 'Jennifer',
age: 15,
})
.return('none')
.execute()
Supported SurrealQL specific statements:
Why not write a query builder from scratch
Kysely is growing to be THE sql query builder solution in the typescript ecosystem. Koskimas' dedication, attention to detail, experience from creating objection.js, project structure, simplicity, design patterns and philosophy, made adding code to that project a really good experience as a contributor. Taking what's great about that codebase, and patching in SurrealQL stuff seems like an easy win in the short-medium term.
License
MIT License, see LICENSE