Skip to content

Interface: DrizzleModuleOptions

Defined in: packages/drizzle/src/interfaces/drizzle-module.interface.ts:7

Options for synchronously configuring the Drizzle module.

Properties

PropertyTypeDescriptionDefined in
dbunknownA pre-configured drizzle-orm database instance. Create the instance using drizzle-orm's dialect-specific helpers before passing it to the module: - PostgreSQL: drizzle(pool, { schema }) - MySQL: drizzle(connection, { schema }) - SQLite: drizzle(database, { schema })packages/drizzle/src/interfaces/drizzle-module.interface.ts:17
isGlobal?booleanIf true, registers DrizzleModule as a global module so the db instance is available throughout the application without re-importing. Default falsepackages/drizzle/src/interfaces/drizzle-module.interface.ts:35
tag?string | symbolCustom injection token for this database instance. Useful when registering multiple DrizzleModule instances in the same application (e.g. primary + analytics databases). Default DRIZZLE_INSTANCEpackages/drizzle/src/interfaces/drizzle-module.interface.ts:27

Released under the MIT License.