Skip to main content

Module config

Module config 

Source
Expand description

Configuration for Drizzle CLI

Handles loading drizzle.config.toml with type-safe credentials. Supports both single-database (legacy) and multi-database configurations.

This configuration format is designed to be compatible with drizzle-kit so TypeScript users can use the same config expectations.

Structs§

Config
Main configuration structure
DatabaseConfig
Configuration for a single database
EntitiesFilter
Entities filter configuration
IntrospectConfig
Introspection configuration
MigrationsOpts
Migration options

Enums§

Casing
Identifier casing strategy for inferred names.
Credentials
Database credentials - validated and typed
Dialect
Database dialect
Driver
Database driver for Rust database connections
EnvOr
A value that’s either a literal string or an env-var reference.
EnvOrError
Failure resolving an EnvOr::Env reference.
Error
Extension
Known PostgreSQL extensions that can be filtered
Filter
Filter (single or multiple values)
IntrospectCasing
Casing mode for introspection (pull command)
MigrationPrefix
PostgresCreds
PostgreSQL credentials
RolesFilter
Roles filter configuration
Schema
Schema path(s)

Constants§

CONFIG_FILE
DEFAULT_DB
Default database name for single-database configs