Skip to content
atarashi
Documentation menu

db/sqlite

File-backed SQLite database via better-sqlite3, with WAL enabled and no server to run.

Provides: database, database:sql, database:sqlite

Requires: runtime:node, config:env

Conflicts with: database

Options

PromptFlagTypeDefault
db.name--db-nameinput"{{ project.slug }}"

Files it writes

  • src/db/client.ts|js (when !has('orm/prisma'))

Dependencies

  • better-sqlite3@^13.0.3 (when !has('orm/prisma'))

Development only:

  • @types/better-sqlite3@^7.6.13 (when provides('language:typescript') && !has('orm/prisma'))

Environment

VariableRequiredDescription
DATABASE_URLyesSQLite database file, as a file: URL

What it contributes to other files

FileSlotLine
src/config/env.ts|jsenv-schemaDATABASE_URL: z.string().min(1),
src/index.ts|jsimportsimport { checkDatabaseConnection } from './db/client.js';
src/index.ts|jsbootstrapcheckDatabaseConnection();

What it merges into other files

  • pnpm-workspace.yaml (yaml-deep)

Use it

atarashi new my-app --add db/sqlite
atarashi add db/sqlite

Version 1.0.0. Format reference: Authoring blueprints.

Part of the atarashi documentation, written and maintained by Gautam Suthar.