Client adapters

Minnow's direct API accepts PostgreSQL-style SQL through query() and execute(). Client adapters let an existing query builder use that same engine without introducing a server or a second database implementation.

Kysely

Kysely is the primary client adapter today. @minnowdb/kysely supplies a dialect backed by either an in-thread MinnowDatabase or a worker-hosted MinnowDatabaseClient.

npm install @minnowdb/core @minnowdb/kysely kysely

import { createKysely } from "@minnowdb/kysely";

await database.migrate(appSchema);
const db = createKysely({ driver: database, schema: appSchema });

Kysely compiles double-quoted identifiers, $1 parameters, transactions, schema statements, and RETURNING with its PostgreSQL compiler. Minnow checks the generated SQL against its supported profile and executes it normally.

The Kysely guide covers inferred schema types, nested correlated subqueries, typed JSON projections and full-text search, live queries, streaming, defaults, generated SQL, introspection, transactions, workers, and embedded-database boundaries.

Build another adapter

Adapters target two small structural interfaces from @minnowdb/core:

• MinnowSqlExecutor provides query(), queryCursor(), and execute().
• MinnowSqlDriver adds introspect() for schema-aware tools.

The extending guide documents those interfaces, statement transactions, catalog introspection, and the machine-readable SQL compatibility profiles.

Typed live-query adapters additionally target the framework-neutral LiveQuerySource and LiveQueryManager contracts. The live-query guide explains why the callable wrapper scales beyond Kysely even though Kysely's $call method does not.