Skip to content
MeshQLMeshQL Docs

meshql-kysely (@meshql/kysely)

Kysely catch-all resolver for MeshQL. Executes join plans as parameterized SQL via db.executeQuery(), using @meshql/postgres or @meshql/sqlite builders. Returns flat rows — the MeshQL shaper nests the response (no { preshaped: true }).

Install

Section titled “Install”
Terminal window
# Postgres
npm install meshql-kysely meshql-core meshql-postgres kysely


# SQLite
npm install meshql-kysely meshql-core meshql-sqlite kysely


# or JSR
npx jsr add @meshql/kysely @meshql/core @meshql/postgres

Published on npm as meshql-kysely and JSR as @meshql/kysely.

Requires @meshql/core 0.6.0+.

Example

Section titled “Example”
import { createMesh, type MeshSchema } from "@meshql/core";
import { withKysely } from "@meshql/kysely";


const schema: MeshSchema = { /* entities + joins */ };
const mesh = createMesh(schema);


withKysely(mesh, db, { schema, dialect: "postgres" });

Equivalent to:

import { kyselyResolver } from "@meshql/kysely";


mesh.resolve("*", kyselyResolver(db, { schema, dialect: "sqlite" }));

Pass your existing Kysely instance. MeshQL does not manage the connection pool — see Database connections.

Exports

Section titled “Exports”
  • withKysely(mesh, db, { schema, dialect })
  • kyselyResolver(db, { schema, dialect }) — dialect: "postgres" | "sqlite"

See also ORM adapters and @meshql/postgres.