Configuration API

configureDatabase(config): Knex

Initialises the ORM from simple options. Recommended for most applications.

import { configureDatabase } from 'mevn-orm'

configureDatabase({
  client: 'better-sqlite3',
  connection: { filename: './dev.sqlite' }
})

SimpleDatabaseConfig

Field	Type	Description
client	string	Preferred driver selector
dialect	string	Deprecated alias of client
connection	Knex connection	Object or connection string
connectionString	string	Alternative to connection string
filename	string	SQLite path when not using connection
host, port, user, password, database		Top-level connection fields
ssl	boolean | object	Passed into connection when built from top-level fields
debug	boolean	Knex debug flag
pool	Knex pool config	Connection pool

Client normalisation

Input	Resolved Knex client
sqlite3, sqlite	better-sqlite3
mysql	mysql2
postgres, postgresql, pg	pg
oracle	oracledb
others listed in types	as-is

SQLite configs set useNullAsDefault: true.

Errors

• Missing client (and dialect): Missing required field "client".
• Missing required host/user/database/filename for the client: Missing required field "…" for client "…".

---

createKnexConfig(config): Knex.Config

Builds a Knex config without setting the global client.

import { createKnexConfig, configure } from 'mevn-orm'

const config = createKnexConfig({
  client: 'pg',
  connection: process.env.DATABASE_URL,
  pool: { min: 0, max: 10 }
})

configure(config)

---

configure(config: Knex.Config | Knex): Knex

Initialises from a full Knex config or an existing Knex instance.

import knex from 'knex'
import { configure } from 'mevn-orm'

configure({
  client: 'pg',
  connection: process.env.DATABASE_URL,
  searchPath: ['public']
})

const db = knex({ /* ... */ })
configure(db)

---

getDB(): Knex

Returns the active Knex instance.

import { getDB } from 'mevn-orm'

const rows = await getDB()('users').select('*')

Throws if not configured:

Mevn ORM is not configured. Call configure({ client, connection, ... }) before using Model.

---

DB

Package export for the Knex instance. Prefer getDB() in application code so missing configuration fails loudly with a clear error.