drizzle

TypeScript

Source files: TypeScript

Create a Drizzle database whose queries run asynchronously on a Nitro SQLite connection. Creating the wrapper does not open, migrate, or close the connection.

Type Parameters

TSchema

TSchema extends Record<string, unknown> = Record<string, never>

Tables and relations supplied in config.schema.

Parameters

connection

NitroSQLiteConnection

Connection returned by open().

config?

DrizzleConfig<TSchema> = {}

Drizzle options such as schema, logger, and casing.

Returns

NitroSQLiteDatabase<TSchema> & object

A database whose $client is the supplied connection.

Throws

If Drizzle cannot read the supplied schema configuration. Query promises reject on binding, SQLite, or closed-connection errors.