Getting started - persistence-drizzle

Install

npm install persistence-drizzle drizzle-orm

Node.js 22.16.0 or later is supported, including the maintained 22, 24 and 26 lines. The root and Capacitor entry points are engine-free; this persistence-drizzle/node example uses node:sqlite and needs that Node floor. drizzle-orm (>=0.45.2 <1) is the only peer dependency.

Open a database

import { integer, sqliteTable, text } from 'drizzle-orm/sqlite-core'
import { openDatabase } from 'persistence-drizzle'
import { createNodeSqliteDriver } from 'persistence-drizzle/node'

const players = sqliteTable('players', {
  id: integer('id').primaryKey(),
  name: text('name').notNull(),
})

const database = await openDatabase({
  driver: createNodeSqliteDriver(),
  schema: { players },
  migrations: [
    { tag: '0000_players', sql: 'CREATE TABLE players (id integer PRIMARY KEY NOT NULL, name text NOT NULL);' },
  ],
})

createNodeSqliteDriver() is an in-memory database; pass a file path to keep it. On a device, use createCapacitorDriver.

Write and read

await database.transaction(async (tx) => {
  await tx.insert(players).values({ id: 1, name: 'Player One' })
})

const rows = await database.db.select().from(players)
await database.close()

Inside transaction, use the tx it gives you. database.db takes the lock for each statement, and the lock is already held by the transaction.

Use drizzle-kit migrations

Generate migrations with drizzle-kit generate, then hand them to openDatabase:

import { readMigrationsFolder } from 'persistence-drizzle/node'

const migrations = readMigrationsFolder('./drizzle') // Node: from disk

In a bundled app, import the journal and the .sql files and call migrationsFromJournal; see migrations.