Expand description
Loading and validating drizzle.config.toml.
A config holds either one database (top-level dialect, schema, …)
or several under [databases.<name>]. Field names follow drizzle-kit, so
a drizzle-kit config translates directly.
Structs§
- Config
- A loaded
drizzle.config.toml. - Database
Config - Settings for one database: the top level of a single-database config,
or one
[databases.<name>]table. - Entities
Filter - The
entitiesfilter: which database entitiespushandpulltouch. - Introspect
Config - The
[introspect]config section. - Migrations
Opts - The
[migrations]config section.
Enums§
- Casing
- Identifier casing strategy for inferred names.
- Config
Value - A config value written inline or read from an environment variable.
- Config
Value Error - Failure resolving a
ConfigValue::Envreference. - Credentials
- Resolved
dbCredentials, with env vars read and values validated. - Dialect
- The
dialectconfig value. - Driver
- The
driverconfig value: which Rust driver the CLI connects with. - Error
- Errors from loading or using a config file.
- Extension
- A PostgreSQL extension for
extensionsFilters; its objects are skipped. - Filter
- A
tablesFilter/schemaFiltervalue: one pattern or a list. - Introspect
Casing - Casing for Rust identifiers written by
introspect/pull. - Migration
Prefix - The
[migrations] prefixvalue: how migration folder names start. - MySQL
Creds - MySQL credentials. Both Rust adapters consume the same resolved shape;
Driverselects the concrete connection effect later. - MySQL
SslMode - MySQL TLS policy: the
sslvalue of host-styledbCredentials(defaultDisable). - Postgres
Creds - PostgreSQL credentials: a URL or host fields.
- Postgres
SslMode - PostgreSQL TLS policy: the
sslvalue of host-styledbCredentials(defaultDisable), or thesslmodeof a URL. - Roles
Filter - The
entities.rolesfilter (PostgreSQL). - Schema
- The
schemaconfig value: one path/glob or a list (defaultsrc/schema.rs).
Constants§
- CONFIG_
FILE - Default config file name, looked up in the current directory.
- DEFAULT_
DB - Name given to the database of a single-database config.
Functions§
- resolve_
schema_ patterns - Resolves schema paths and glob patterns to the files they name.