Documentation

Documentation / @zerotal/orm / index / DatabaseProvider

Class: DatabaseProvider

Defined in: packages/orm/src/provider/DatabaseProvider.ts:46

Service provider that wires the ORM into a Zerotal application.

Remarks

Register this provider to get: the db container binding (a Bun.sql connection, optionally wrapped in a read/write router when database.replicas is set), convention auto-discovery of app/models and app/observers, auto-migration, implicit route-model binding, N+1 detection outside production, validator unique/exists rule wiring, and the migrate / make:* / db:seed CLI commands. The connection URL, pool, replicas, and dialect are read from the database config namespace (see DatabaseConfig).

Example

// config/app.ts
providers: [DatabaseProvider]

Extends

• ServiceProvider

Constructors

Constructor

new DatabaseProvider(app): DatabaseProvider

Defined in: packages/core/src/provider/ServiceProvider.ts:44

Parameters

app

Application

Returns

DatabaseProvider

Inherited from

ServiceProvider.constructor

Properties

dependsOn?

static optional dependsOn?: (app) => ServiceProvider[]

Defined in: packages/core/src/provider/ServiceProvider.ts:35

Other providers this one needs. They are pulled into the application automatically (transitively, de-duplicated) and guaranteed to boot before this provider — so you only have to register the feature you want, not its plumbing. Reference the provider classes directly:

Parameters

app

Application

Returns

ServiceProvider

Example

static override dependsOn = [FlowProvider];

Inherited from

ServiceProvider.dependsOn

priority?

static optional priority?: number

Defined in: packages/core/src/provider/ServiceProvider.ts:42

Boot-order tiebreak among providers with no dependsOn relationship. Lower boots earlier; defaults to 0. Handy for framework-core providers (e.g. static override priority = -100).

Inherited from

ServiceProvider.priority

app

protected app: Application

Defined in: packages/core/src/provider/ServiceProvider.ts:44

Inherited from

ServiceProvider.app

provides

static provides: readonly ["db"]

Defined in: packages/orm/src/provider/DatabaseProvider.ts:47

Container tokens this provider registers. Required when using the array form of app.defer([Provider, ...]).

Example

static override provides = ['cache'] as const;

Overrides

ServiceProvider.provides

environments

static environments: AppEnvironment[]

Defined in: packages/orm/src/provider/DatabaseProvider.ts:49

Environments in which this provider is active. Defaults to all of them.

Overrides

ServiceProvider.environments

Methods

onStarting()

onStarting(): Promise<void>

Defined in: packages/core/src/provider/ServiceProvider.ts:53

Run just before the app starts accepting work (e.g. the HTTP server).

Returns

Promise<void>

Inherited from

ServiceProvider.onStarting

onStarted()

onStarted(): Promise<void>

Defined in: packages/core/src/provider/ServiceProvider.ts:55

Run once the app has started.

Returns

Promise<void>

Inherited from

ServiceProvider.onStarted

onStopped()

onStopped(): Promise<void>

Defined in: packages/core/src/provider/ServiceProvider.ts:59

Run once shutdown is complete.

Returns

Promise<void>

Inherited from

ServiceProvider.onStopped

onRequestReceived()

onRequestReceived(_ctx): Promise<void>

Defined in: packages/core/src/provider/ServiceProvider.ts:66

Called before the middleware pipeline runs.

Parameters

_ctx

HttpContext

Returns

Promise<void>

Inherited from

ServiceProvider.onRequestReceived

onRequestProcessed()

onRequestProcessed(_ctx): Promise<void>

Defined in: packages/core/src/provider/ServiceProvider.ts:69

Called after the pipeline completes and ctx.response is set.

Parameters

_ctx

HttpContext

Returns

Promise<void>

Inherited from

ServiceProvider.onRequestProcessed

onResponseSent()

onResponseSent(_ctx): Promise<void>

Defined in: packages/core/src/provider/ServiceProvider.ts:72

Called after the response has been sent to the client.

Parameters

_ctx

HttpContext

Returns

Promise<void>

Inherited from

ServiceProvider.onResponseSent

onRegister()

onRegister(): void

Defined in: packages/orm/src/provider/DatabaseProvider.ts:53

Register container bindings. Runs before any provider boots; do not resolve services here.

Returns

void

Overrides

ServiceProvider.onRegister

onBooting()

onBooting(): Promise<void>

Defined in: packages/orm/src/provider/DatabaseProvider.ts:105

Resolve and prepare services before the app is considered booted.

Returns

Promise<void>

Overrides

ServiceProvider.onBooting

replContext()

replContext(): Record<string, unknown>

Defined in: packages/orm/src/provider/DatabaseProvider.ts:160

Variables to expose in bun zt repl. Override in any provider to make its facades available by name in the REPL session.

Returns

Record<string, unknown>

Example

override replContext() { return { DB, Mail }; }

Overrides

ServiceProvider.replContext

onStopping()

onStopping(): Promise<void>

Defined in: packages/orm/src/provider/DatabaseProvider.ts:164

Run when the app begins a graceful shutdown; release resources here.

Returns

Promise<void>

Overrides

ServiceProvider.onStopping

onBooted()

onBooted(): Promise<void>

Defined in: packages/orm/src/provider/DatabaseProvider.ts:177

Run once all providers have booted and every binding is available.

Returns

Promise<void>

Overrides

ServiceProvider.onBooted