Skip to main content

Interface: DatabaseConfig

Defined in: packages/persistence/src/database.ts:10

A database connection, as configuration states it. The field names are the shape of databaseConfigSchema, so a loaded database block passes straight in.

Properties​

host​

readonly host: string

Defined in: packages/persistence/src/database.ts:12

Postgres host.


name​

readonly name: string

Defined in: packages/persistence/src/database.ts:16

The database name: platform for the credential and gateway-side modules.


password​

readonly password: Secret<string>

Defined in: packages/persistence/src/database.ts:24

The role's password, resolved from a secret reference.


pool​

readonly pool: object

Defined in: packages/persistence/src/database.ts:26

The pool. max is DECLARED: the connection budget is summed from it.

max​

readonly max: number

The most connections this pool opens.


port​

readonly port: number

Defined in: packages/persistence/src/database.ts:14

Postgres port.


role​

readonly role: string

Defined in: packages/persistence/src/database.ts:22

The login role. NAMED on purpose and never defaulted: a module connects as its own <module>_app (runtime) or <module>_owner (migrations), never as a shared one, because one writer per table is enforced by the role.