Struct DatabaseConfig 

pub struct DatabaseConfig {

    pub dialect: Dialect,
    pub schema: Schema,
    pub out: PathBuf,
    pub breakpoints: bool,
    pub driver: Option<Driver>,
    pub tables_filter: Option<Filter>,
    pub schema_filter: Option<Filter>,
    pub extensions_filters: Option<Vec<Extension>>,
    pub entities: Option<EntitiesFilter>,
    pub casing: Option<Casing>,
    pub introspect: Option<IntrospectConfig>,
    pub verbose: bool,
    pub migrations: Option<MigrationsOpts>,
    /* private fields */
}

Configuration for a single database

This structure matches drizzle-kit’s config format for compatibility.

Fields

dialect: Dialect

Database dialect (required)

schema: Schema

Path(s) to schema file(s) - supports glob patterns

out: PathBuf

Output directory for migrations (default: “./drizzle”)

breakpoints: bool

Whether to use SQL breakpoints in migrations (default: true)

driver: Option<Driver>

Database driver for Rust connections

tables_filter: Option<Filter>

Table name filter (glob patterns supported)

schema_filter: Option<Filter>

Schema name filter (PostgreSQL only)

extensions_filters: Option<Vec<Extension>>

Extensions filter (PostgreSQL only, e.g., ["postgis"])

entities: Option<EntitiesFilter>

Entities filter (roles, etc.)

casing: Option<Casing>

Casing mode for generated code

introspect: Option<IntrospectConfig>

Introspection configuration

verbose: bool

Verbose output

migrations: Option<MigrationsOpts>

Migration table configuration

Implementations

impl DatabaseConfig

pub fn credentials(&self) -> Result<Option<Credentials>, Error>

Get typed credentials, resolving any environment variable references.

Errors

Returns Error if a referenced environment variable is missing or invalid, or if the credentials block does not match the configured dialect.

pub fn migrations_dir(&self) -> &Path

Migrations output directory

pub fn meta_dir(&self) -> PathBuf

Meta directory (for journal)

pub fn journal_path(&self) -> PathBuf

Journal file path

pub fn schema_display(&self) -> String

Schema paths display string

pub fn schema_files(&self) -> Result<Vec<PathBuf>, Error>

Resolve schema files (with glob support).

Errors

Returns Error if a glob pattern is invalid, if expanding a glob fails, or if the resolved pattern matches zero files.

pub fn effective_casing(&self) -> Casing

Get effective casing mode (default: camelCase)

pub fn effective_introspect_casing(&self) -> IntrospectCasing

Get effective introspect casing mode (default: camel)

pub fn effective_entities(&self) -> EntitiesFilter

Get entities filter (default: empty)

pub fn should_include_role(&self, role_name: &str) -> bool

Check if a role should be included based on entities filter

pub fn roles_enabled(&self) -> bool

Check if roles are enabled in entities filter

pub fn extensions(&self) -> &[Extension]

Get extensions filters (PostgreSQL only)

pub fn has_extension(&self, ext: Extension) -> bool

Check if an extension is in the filter list

pub fn migrations_table(&self) -> &str

Get migration table name (default: __drizzle_migrations)

pub fn migrations_schema(&self) -> &str

Get migration schema (PostgreSQL only, default: drizzle)

pub fn bundle_enabled(&self) -> bool

Should a bundled migrations.js index be emitted alongside migration.sql?

Resolution order:

1. Explicit [migrations] bundle = true/false in the config wins.
2. Otherwise, auto-enable for driver = "durable-sqlite" since Durable Objects need the JS index to import migrations at Worker build time (there’s no other way to ship SQL into a DO).
3. Otherwise, default to false.

Trait Implementations

impl Clone for DatabaseConfig

fn clone(&self) -> DatabaseConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DatabaseConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DatabaseConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for DatabaseConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.