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
- Database
Config - Configuration for a single database
- Entities
Filter - Entities filter configuration
- Introspect
Config - Introspection configuration
- Migrations
Opts - Migration options
Enums§
- Casing
- Identifier casing strategy for inferred names.
- Config
Value - A config value that is either inline or an env-var reference.
- Config
Value Error - Failure resolving a
ConfigValue::Envreference. - Credentials
- Database credentials - validated and typed
- Dialect
- Database dialect
- Driver
- Database driver for Rust database connections
- Error
- Extension
- Known
PostgreSQLextensions that can be filtered - Filter
- Filter (single or multiple values)
- Introspect
Casing - Casing mode for introspection (pull command)
- Migration
Prefix - MySQL
Creds - MySQL credentials. Both Rust adapters consume the same resolved shape;
Driverselects the concrete connection effect later. - MySQL
SslMode - MySQL TLS policy accepted by URL/host CLI configuration.
- Postgres
Creds PostgreSQLcredentials- Postgres
SslMode - Roles
Filter - Roles filter configuration
- Schema
- Schema path(s)
Constants§
- CONFIG_
FILE - DEFAULT_
DB - Default database name for single-database configs
Functions§
- resolve_
schema_ patterns - Resolves schema paths and glob patterns to the files they name.