Module config

Module config 

Source
Expand description

(Exported for documentation only) Guide and reference for sqlx.toml files.

To use, create a sqlx.toml file in your crate root (the same directory as your Cargo.toml). The configuration in a sqlx.toml configures SQLx only for the current crate.

Requires the sqlx-toml feature (not enabled by default).

sqlx-cli will also read sqlx.toml when running migrations.

See the Config type and its fields for individual configuration options.

See the reference for the full sqlx.toml file.

Modules§

_reference
Reference for sqlx.toml files
common
Configuration shared by multiple components.
drivers
macros
Configuration for the query!() family of macros.
migrate
Configuration for migrations when executed using sqlx::migrate!() or through sqlx-cli.

Structs§

Config
The parsed structure of a sqlx.toml file.

Enums§

ConfigError
Error returned from various methods of Config.