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 */
}

Settings for one database: the top level of a single-database config, or one [databases.<name>] table.

Field names match drizzle-kit (dbCredentials, tablesFilter, …).

Fields

dialect: Dialect

Database dialect (required)

schema: Schema

Schema file paths or glob patterns, relative to the config file.

out: PathBuf

Migrations folder (default ./drizzle), relative to the config file.

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 preference for generated names. Currently ignored when building snapshots: table macros always snake_case inferred names.

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>

Returns typed credentials, reading any { env = "VAR" } values.

Returns None when dbCredentials is absent or its shape does not fit the dialect (loading a config already rejects most such mismatches).

Errors

Returns Error if a referenced environment variable is unset or not valid UTF-8, or an ssl value is not a recognized mode.

pub fn migrations_dir(&self) -> &Path

Returns the migrations folder (out).

pub fn meta_dir(&self) -> PathBuf

Returns out/meta, where legacy drizzle-kit layouts keep the journal.

pub fn journal_path(&self) -> PathBuf

Returns the legacy out/meta/_journal.json path.

pub fn schema_display(&self) -> String

Returns the schema paths joined for display.

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

Resolves schema paths and globs to files.

Errors

Returns Error if a listed path is missing, if a glob pattern is invalid, fails to expand or matches no file (see resolve_schema_patterns), or if nothing is listed at all.

pub fn effective_casing(&self) -> Casing

Returns casing, or camelCase when unset.

pub fn effective_introspect_casing(&self) -> IntrospectCasing

Returns introspect.casing, or camel when unset.

pub fn effective_entities(&self) -> EntitiesFilter

Returns the entities filter, or the default when unset.

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

Returns true if role_name passes the entities.roles filter (false when no entities filter is set).

pub fn roles_enabled(&self) -> bool

Returns true if the entities.roles filter is enabled.

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

Returns the extensionsFilters list (PostgreSQL only; empty when unset).

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

Returns true if ext is in extensionsFilters.

pub fn migrations_table(&self) -> &str

Returns the migrations tracking table (default __drizzle_migrations).

pub fn migrations_schema(&self) -> &str

Returns the migrations tracking 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) -> Self

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.