Documentation / @zerotal/orm / index / DatabaseConfig

Function: DatabaseConfig()

DatabaseConfig(options?): DatabaseConfigShape

Defined in: packages/orm/src/config.ts:80

Create a typed database configuration object with defaults.

IMPORTANT: For SQLite, do NOT use a 'sqlite://' protocol prefix. Bun's native SQLite driver expects a raw file path or ':memory:'.

Parameters

options?

Partial<DatabaseConfigShape> = {}

Returns

DatabaseConfigShape

Example

import { DatabaseConfig } from '@zerotal/orm';
export default DatabaseConfig({
  driver: 'sqlite',
  url:    env('DATABASE_URL', './database/db.sqlite'),
});