Skip to content

monolayer / schema / PgDatabaseConfig

Type Alias: PgDatabaseConfig ​

PgDatabaseConfig: object

Type declaration ​

camelCase? ​

optional camelCase: boolean

Whether to convert camelCase column names to snake_case column names in the database.

Default ​

ts
false

extensions? ​

optional extensions: PgExtension[]

Extensions to install in the database.

Default ​

ts
[]

generatePrismaSchema? ​

optional generatePrismaSchema: boolean

Whether to generate a Prisma schema for the database after running migrations.

Default ​

ts
false

id? ​

optional id: string

Id of the database.

Default ​

ts
"default"

prismaSchemaPath? ​

optional prismaSchemaPath: string

Path to the Prisma schema to use when generating.

Default ​

ts
"prisma/schema.prisma"

schemas? ​

optional schemas: AnySchema[]

Schemas in the database.

Default ​

ts
[]

seeder()? ​

optional seeder: (db) => Promise<void>

Function to seed the database with data.

Parameters ​

ParameterType
dbKysely<any>

Returns ​

Promise<void>